This documentation's source template was taken from the Spinal HDL <https://github.com/SpinalHDL/SpinalDoc-RTD>
_ project.
The theme is based on the PyData Sphinx Theme <https://pydata-sphinx-theme.readthedocs.io/en/latest/>
_
For more detailed usage instructions, see the Open Ephys Doc Template <https://github.com/open-ephys/doc-template>
_
Requirements (Python 3):
Create a virtual environment with pipenv (will use the Pipfile for installing the necessary packages)
.. code:: shell
pipenv install
then you can build the documentation
.. code:: shell
pipenv run make html
if you want run make
multiple times, prepend pipenv run
on each command can be annoying,
you can spawn a subshell with
.. code:: shell
pipenv shell
and then you can use make
the usual way
.. code:: shell
make html # for html make latex # for latex make latexpdf # for latex (will require latexpdf installed) make # list all the available output format
all the outputs will be in docs folder (for html: docs/html)
Requirements (system):
Requirements (Python 3):
After installing the requirements you can run
.. code:: shell
make html # for html make latex # for latex make latexpdf # for latex (will require latexpdf installed) make # list all the available output format