Build the Sphinx documention

With this notebook you can builld a local copy of FRETBursts documentation.

Make sure you have installed sphinx 1.3+ which includes the napoleon extension.

You will also need the theme sphinx_rtd_theme. You can install it via conda:

conda install sphinx_rtd_theme



In [ ]:

    
import os

DOCS_DIR = r'../../../docs/source/'
HTML_DIR= os.path.abspath('.') + '/docs_html/'



In [ ]:

    
!sphinx-build -b html "$DOCS_DIR" "$HTML_DIR"

Read the generated documentation here.



In [ ]:

Stash area



In [ ]:

    
print('sphinx-build -b html "%s" "%s"' % (DOCS_DIR, HTML_DIR))



In [ ]:

    
print(HTML_DIR)



In [ ]: