Skip to content
This repository was archived by the owner on Jan 31, 2022. It is now read-only.

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

GTN Documentation

Building the Docs

To build the documentation, follow the steps below.

Setup (do once)

Install Doxygen.

Install breathe and the sphinx theme using the requirements.txt file in docs/:

pip install -r requirements.txt

Build

From docs/:

doxygen && make html

If you run into issues rebuilding the docs, run make clean before building again.

View the Docs

Run a server in docs/build/html:

python -m http.server <port>

Point browser to http://localhost:<port>.