Skip to content

Latest commit

 

History

History
 
 

docs

TAC Documentation

Dependency

This requires pandoc to be installed locally. See here for instructions.

Build

  • Before getting started, check that:

    • You have followed the steps under 'Dependencies' and 'Preliminaries' on root readme.
    • You have installed the development dependencies as described on root readme.
  • Activate the virtual environment:

    pipenv shell
    
  • Enter docs:

    cd docs
    
  • Run:

    sphinx-apidoc -o reference/api/ ../tac/
    make html
    

Display

To display the documentation in your browser, open the index.html file in ./_build/html/index.html.

  • From terminal do
firefox _build/html/index.html
  • or
open _build/html/index.html