Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Projects
FMC TDC 1ns 5cha
Commits
5b988b45
Commit
5b988b45
authored
Jan 24, 2022
by
Federico Vaga
Committed by
Adam Wujek
Mar 19, 2022
Browse files
add README file
Signed-off-by:
Federico Vaga
<
federico.vaga@cern.ch
>
parent
b0a23b73
Changes
1
Show whitespace changes
Inline
Side-by-side
README.rst
0 → 100644
View file @
5b988b45
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/
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment