Skip to content
Snippets Groups Projects
Commit 8847785d authored by juga's avatar juga
Browse files

Add doc about the doc

parent 66213ea5
No related branches found
No related tags found
No related merge requests found
......@@ -38,3 +38,15 @@ accept any password in the file.
**lib/circuitbuilder.py** Only one subclass of CircuitBuilder is used as of
this writing, and that is GapsCircuitBuilder. Oddly enough, there are no gaps
in the circuits we ask it to build.
# Documentation
See more documentation in [/docs/source/](/docs/source/)
## Build HTML documentation
pip install -e .[doc]
cd docs
make html
The generated HTML will be in [/docs/build/](/docs/build/)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment