Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
F
FMC TDC 1ns 5cha
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
1
Issues
1
List
Board
Labels
Milestones
Merge Requests
1
Merge Requests
1
Wiki
Wiki
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Projects
FMC TDC 1ns 5cha
Commits
4e02f309
Commit
4e02f309
authored
Jan 24, 2022
by
Federico Vaga
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
add README file
Signed-off-by:
Federico Vaga
<
federico.vaga@cern.ch
>
parent
45c33cd1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
0 deletions
+30
-0
README.rst
README.rst
+30
-0
No files found.
README.rst
0 → 100644
View file @
4e02f309
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