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

Use Sphinx to generate documentation. #3

Merged
merged 2 commits into from Nov 13, 2019
Merged

Conversation

munshkr
Copy link
Contributor

@munshkr munshkr commented Nov 11, 2019

Includes an index.rst based on README.md, and sets autodoc and other Sphinx extensions for autogenerating module documentation from docstrings.

Personally, I also recommend configuring readthedocs for free hosting and automatic generation on git pushes :)

@munshkr
Copy link
Contributor Author

munshkr commented Nov 11, 2019

To generate:

cd docs/ && make html

To see docs:

cd docs/_build/html
python3 -m http.server

Then browse http://localhost:8000

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