... | ... | @@ -22,6 +22,44 @@ Here the list of supported ADC devices: |
|
|
- [FMC ADC 100M 14Bit 4
|
|
|
Channel](https://www.ohwr.org/project/fmc-adc-100m14b4cha-sw)
|
|
|
|
|
|
# Documentation
|
|
|
|
|
|
The library uses [Sphinx](http://www.sphinx-doc.org/en/master/) to
|
|
|
generate documentation from
|
|
|
[reStructuredText](http://docutils.sourceforge.net/rst.html) files under
|
|
|
`doc/`.
|
|
|
|
|
|
To build the documentation, it is highly recommended to setup a [Python
|
|
|
virtual environment](https://virtualenv.pypa.io/en/stable/) where the
|
|
|
necessary packages (docuilts, sphinx, etc.) can be installed and via
|
|
|
[pip](https://pypi.org/project/pip/) kept at a specific version. The
|
|
|
following steps illustrate how to do this on a Debian/Ubuntu Linux box,
|
|
|
with the virtual environment placed inside the `doc/` folder of the
|
|
|
project:
|
|
|
|
|
|
$> sudo apt install virtualenv
|
|
|
$> cd doc
|
|
|
$> virtualenv build_env
|
|
|
$> . build_env/bin/activate
|
|
|
$> pip install -r requirements.txt
|
|
|
$> deactivate
|
|
|
|
|
|
Once the environment is installed, you can (re)build the documentation
|
|
|
by doing:
|
|
|
|
|
|
$> cd doc
|
|
|
$> . build_env/bin/activate
|
|
|
$> make html
|
|
|
$> deactivate
|
|
|
|
|
|
The generated documentation can be accessed by opening
|
|
|
`doc/_build/html/index.html` in your browser.
|
|
|
|
|
|
Alternatively, if you have [LaTeX](https://www.latex-project.org/)
|
|
|
installed, you can produce a PDF by doing a `make latexpdf` instead. The
|
|
|
generated documentation can be accessed by opening
|
|
|
`doc/_build/latex/adclib.pdf`.
|
|
|
|
|
|
|
|
|
|
|
|
### Files
|
... | ... | |