search

networkx / networkx-metis

NetworkX Addon to allow graph partitioning with METIS
Other
78 stars 21 forks source link

Generates documentation from docstrings #15

Closed OrkoHunter closed 9 years ago

OrkoHunter commented 9 years ago

Fixes #13

I've temporarily split the PR into 3 commits. Basically, the last (or last two) commits are to be reviewed.

After setting up a hook on readthedocs.org, the built docs would be available here for testing purposes and then finally can be published at http://networkx-metis.readthedocs.org/en/latest/

Edit : They are now available at http://orkohunter-networkx-metis.readthedocs.org/en/doc/

OrkoHunter commented 9 years ago

The reason why this page on documentation is vacant where it should have been populated by the automodule extension, is probably because sphinx is not being able to identify networkx.addons.metis as a package. Maybe after setup.py installs networkx-metis, it would work.

Build log

OrkoHunter commented 9 years ago

After adding doc/requirements.txt, the documentation is building in the reference area too. http://orkohunter-networkx-metis.readthedocs.org/en/doc/

OrkoHunter commented 9 years ago

I currently don't have the content for Who uses NetworkX-Metis and Goals section in the overview. If there's not anything to write in there, we can remove it.

OrkoHunter commented 9 years ago

Are we good with this? If there is no urgent need for changes, we can merge this to have our first documentation page published and modify things later after reading it.

chebee7i commented 9 years ago

Yeah, let's just get this in. Note, it might be nice to use the IPython directive for documentation.

http://matplotlib.org/sampledoc/ipython_directive.html https://ipython.org/ipython-doc/dev/api/generated/IPython.sphinxext.ipython_directive.html

OrkoHunter commented 9 years ago

That's a good point. Currently we don't have much examples in the documentation, but IPython directive should be followed.

SanketDG commented 9 years ago

Should the function MetisRStatus be documented? Doesn't it act as a helper function for MetisError? Correct me if I'm wrong.

OrkoHunter commented 9 years ago

@SanketDG You are right. The MetisRStatus class in enums.py should be documented but that would be exactly same as what's in the docstring of MetisError class in exceptions.py

SanketDG commented 9 years ago

@OrkoHunter I see. But leaving it blank seems incomplete.

OrkoHunter commented 9 years ago

Yes surely. That's bad.