Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation on installation of python-igraph #445

Merged
merged 5 commits into from Oct 15, 2021

Conversation

vtraag
Copy link
Member

@vtraag vtraag commented Oct 13, 2021

A user reported in the forum that after installation of python-igraph using conda it could be checked that it was properly installed by doing

import igraph.tests
igraph.test.run_tests()

However, this has never worked like that, at least not since python-igraph 0.8.0 (as far as I could check).

This PR fixes that issue.

There are some other issues that we should also address:

  • The section on installing python-igraph from PyPI also mentions running the tests using python -m unittest discover. @ntamas, if I'm correct, this does not work, right? As far as I can see, no test files are included in any of the binary wheels at least, only in the source tarball.
  • All of the commands (i.e. leading with $) are being rendered in normal font. This also messes up some commands, as it renders -- as an em-dash . I think the code blocks should be introduced with double colons instead of a single colon?
  • Some links are incorrectly formatted, most likely because of line-breaks in the .rst.
  • Pieces of code also seem to be incorrectly rended, and should be within double backticks, not single backticks I believe.

I can further correct these tomorrow.

@ntamas
Copy link
Member

ntamas commented Oct 14, 2021

The section on installing python-igraph from PyPI also mentions running the tests using python -m unittest discover.

You are correct, this is outdated. It worked for the source tarball some years ago but probably not any more (and I plan to migrate to pytest in the long run anyway). This can be removed from the instructions. Also, we don't ship unit tests any more with python-igraph

You are also correct in all the other formatting-related issues.

@vtraag vtraag marked this pull request as ready for review October 15, 2021 12:41
@vtraag
Copy link
Member Author

vtraag commented Oct 15, 2021

I've now only corrected the formatting for the install page, but we should still correct the formatting for the entire user guide. I've opened issue #447 for that to not loose track.

@vtraag
Copy link
Member Author

vtraag commented Oct 15, 2021

AFAIC this can be merged.

@ntamas ntamas merged commit 879c0a4 into igraph:master Oct 15, 2021
@ntamas
Copy link
Member

ntamas commented Oct 15, 2021

Thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants