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 docstrings and put documentation on http://readthedocs.org #27

Closed
mgeier opened this issue Apr 1, 2014 · 5 comments
Closed

Update docstrings and put documentation on http://readthedocs.org #27

mgeier opened this issue Apr 1, 2014 · 5 comments
Labels
Milestone

Comments

@mgeier
Copy link
Contributor

mgeier commented Apr 1, 2014

We could probably write our docstrings in NumPy format:
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Probably the numpydoc extension for Sphinx could be used:
https://github.com/numpy/numpydoc

@mgeier
Copy link
Contributor Author

mgeier commented Jun 2, 2014

Actually, sphinxcontrib.napoleon is better than numpydoc.

I tried it on another project (http://schunk.rtfd.org/) and it worked much better than numpydoc. Also, it will be included into Sphinx with the next release.

@bastibe
Copy link
Owner

bastibe commented Jun 6, 2014

As far as I can see, both documentation styles are roughly compatible with Numpy docstrings. I like the Numpy formatting.

@mgeier
Copy link
Contributor Author

mgeier commented Jun 15, 2014

The documentation style would be the same either way. The two extensions just produce somehow differently formatted output.

@bastibe
Copy link
Owner

bastibe commented Sep 21, 2014

Work on this has started in #74

@mgeier mgeier modified the milestone: 0.6.0 Oct 26, 2014
@mgeier
Copy link
Contributor Author

mgeier commented Nov 16, 2014

I'm closing this because it was done in #74.
The result can be seen there: http://pysoundfile.rtfd.org.

@mgeier mgeier closed this as completed Nov 16, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants