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

Document sphinx hook and possibly add into package #8

Open
foster999 opened this issue Mar 6, 2021 · 1 comment
Open

Document sphinx hook and possibly add into package #8

foster999 opened this issue Mar 6, 2021 · 1 comment

Comments

@foster999
Copy link
Contributor

Document the docs conf.py hook used in the package docs to generate output logs as part of a sphinx build.

@foster999
Copy link
Contributor Author

foster999 commented Jun 27, 2021

It might be worth rewriting the tool as a sphinx extension if the need for this becomes apparent (please shout if interested).

Until then, see the bottom of sphinx conf.py for examples of hooking assumptions into a sphinx documentation build. Alternatively, the CLI could be called from the sphinx make file.

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