README.rst 961 Bytes
Newer Older
Federico Vaga's avatar
Federico Vaga committed
1 2
.. SPDX-FileCopyrightText: 2022 CERN (home.cern)
..
Federico Vaga's avatar
Federico Vaga committed
3
.. SPDX-License-Identifier: CC-BY-SA-4.0+
Federico Vaga's avatar
Federico Vaga committed
4

Federico Vaga's avatar
Federico Vaga committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
FMC TDC 1 ns 5 Channels
=======================

Documentation
-------------
For the documentation we use `Sphinx`_ and `Doxygen`_. You can build
it yourself using ``make`` and specifying the output target. For
example, to build an HTML website you can type the following command
from the project's top directory.

::

    make -C doc html

You will find the documentation in  ``doc/_build/html``.

If the build fails, you are probably missing some required
packages. Have a look at the requirements file
``doc/requirements.txt``. You can install them from your sidtribution
repository or them from `PyPI`_ using the following command.

::

    pip install -r doc/requirements.txt

Remember also to install `Doxygen`_ on your system.

.. _`Sphinx`: https://www.sphinx-doc.org/en/master/
.. _`Doxygen`: https://www.doxygen.nl/index.html
.. _`PyPI`: https://pypi.org/