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

Sphynx doc with usage and also API #86

Closed
scls19fr opened this issue May 15, 2018 · 3 comments
Closed

Sphynx doc with usage and also API #86

scls19fr opened this issue May 15, 2018 · 3 comments

Comments

@scls19fr
Copy link
Member

scls19fr commented May 15, 2018

Maybe a real doc (using Sphynx for example) should be written.

Here is an example (which probably have room for improvement)
http://windrose.readthedocs.io/en/latest/install.html
https://github.com/python-windrose/windrose/tree/master/docs

Sphynx is not limited to reStructuredText, it also accept Markdown (which is better for most contributors)

API doc is generate automatically and can be build for each push using trigger and/or Travis build.

Doc can be available at Read The Docs or as GitHub pages.
I don't know what is the best...

Anyone want to tackle this?

@scls19fr
Copy link
Member Author

scls19fr commented May 16, 2018

With doctests #89 (PR #90) API doc looks much better

@scls19fr
Copy link
Member Author

#92 provides Sphynx doc.

@k-bx could you go to https://readthedocs.org/dashboard/import/ to import it.

RTD can be set to automatically build doc for every push.

@scls19fr
Copy link
Member Author

A screenshot to show how doc looks like

capture d ecran 2018-05-25 a 21 03 58

scls19fr added a commit that referenced this issue May 26, 2018
* Doc with Sphynx
Install, usage, development and API doc
Closes #86
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

No branches or pull requests

1 participant