Skip to content

Latest commit

 

History

History

docs

Sphinx Local Build

# 1. Build N2 library locally.
(this is needed as Sphinx extracts documentation from an importable module.)
# 1-1. Build Preparation
$ pip install -r docs/requirements.txt
# install doxygen
$ git submodule update --init

# 1-2. Build N2. You can use either of the following commands.
# (Note that you need to use gcc that supports C++14.)
$ pip install .
$ python setup.py build_ext --inplace

# 2. Sphinx Build
$ cd docs && make clean && make html

(side note) Instead of running 1-2. and 2., you can run make n2 && make clean && make html inside docs/ directory.

Then you can view the documentation page by opening the docs/_build/html/index.html.