Developer and Internals » Documentation Guide

Adding a website page

Add a doc/pagename.dox file, copy up-to-date license header.
Add a @page definition and title to your page
If the page is top-level, list it in doc/00-page-order.dox to ensure it gets listed at a proper place
If the page is not top-level, list it using @subpage in its parent page
Leverage @section and @subsection to separate the page

More details on how to format your documentation can be found here:
Use the inline commands for latex \f $ <formula_here> \f $ (no space between f and $)
Use block to have equation centered on page \f [ <big_formula_here> \f ] (no space between f and [])

Clone the m.css repository which has scripts to build
- Ensure that it is not in the same folder as your open_vins
- git clone https://github.com/mosra/m.css
- This repository contains the script that will generate our documentation
You will need to install python3.6
- sudo add-apt-repository ppa:deadsnakes/ppa
- sudo apt-get update
- sudo apt-get install python3.6
- curl https://bootstrap.pypa.io/get-pip.py | sudo python3.6
- sudo -H pip3.6 install jinja2 Pygments
- sudo apt install texlive-base texlive-latex-extra texlive-fonts-extra texlive-fonts-recommended
To use the bibtex citing you need to have
- bibtex executable in search path
- perl executable in search path
- http://www.doxygen.nl/manual/commands.html#cmdcite
Go into the documentation folder and build
- cd m.css/documentation/
- python3.6 doxygen.py <path_to_Doxyfile-mcss>
If you run into errors, ensure your python path is set to use the 3.6 libraries
- export PYTHONPATH=/usr/local/lib/python3.6/dist-packages/
You might need to comment out the enable_async=True flag in the doxygen.py file
This should then build the documentation website
Open the html page /open_vins/doxgen_generated/html/index.html to view documentation