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

How to generate documentation #9

Closed
j0yu opened this issue Jun 12, 2019 · 0 comments · Fixed by #22
Closed

How to generate documentation #9

j0yu opened this issue Jun 12, 2019 · 0 comments · Fixed by #22
Labels
docs Documentation related enhancement New feature or request

Comments

@j0yu
Copy link

j0yu commented Jun 12, 2019

Is your feature request related to a problem? Please describe.
Write up on how to generate the documentation and when developing, forcing the CI to generate pages

Describe the solution you'd like
New howto/makedocs.rst outlining setting up venv and modifying .travis.yml (and why generally it is not a good idea)

Additional context

rm -rf ./docs/api/ ./docs/_build/
source /path/to/docs/venv/bin/activate
sphinx-apidoc -o ./docs/api --separate --no-toc ./
sphinx-apidoc -o ./docs/api/hooks --separate --tocfile index ./hooks
sphinx-build ./docs ./docs/_build
@j0yu j0yu added docs Documentation related enhancement New feature or request labels Jun 12, 2019
@j0yu j0yu mentioned this issue Jul 19, 2019
@j0yu j0yu closed this as completed in #22 Jul 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant