Skip to content

compile_docs

Jump to bottom Edit New page
Donny Winston edited this page Dec 9, 2016 · 2 revisions

How to compile FireWorks docs

  1. Make the changes to the docs/ folder of FireWorks (add/modify RST files)
  2. Open a terminal and go to the docs/ folder. do not do this in the root FireWorks folder
  3. Ensure you have pip install Sphinxed in your local environment (conda/virtualenv)
  4. Once inside the docs folder, type "sphinx-apidoc -o . -f ../fireworks; make html"
  5. It will probably spit out some warnings ... no big deal
  6. Find docs/_build/html and open up a web browser for your HTML (e.g. index.html)
Add a custom footer
Add a custom sidebar
Clone this wiki locally