FOSS Flow For FPGA
Find a file
Tim Ansell 6afd2c540f
Merge pull request from antmicro/fix_fuzzers_and_minitests
Fix fuzzers and minitests sections
2020-04-01 10:16:21 -07:00
doxygen
source Merge pull request from antmicro/fix_fuzzers_and_minitests 2020-04-01 10:16:21 -07:00
.gitignore
.gitmodules
COPYING
enter-env.sh
environment.yml
Makefile Merge pull request from antmicro/fix_fuzzers_and_minitests 2020-04-01 10:16:21 -07:00
README.rst
readthedocs.yml
requirements.txt

===============
Getting Started
===============

Building documentation
----------------------

Activate the virtual environment and install dependencies::

    make env
    source enter-env.sh

Build the whole documentation::

    make html

For more options see::

    make help

Packages in virtual environment
-------------------------------

To install packages in conda environment you can use both
``conda`` and ``pip``.

Note that ``pip`` is installed in the conda environment which uses ``python3``,
and is related to ``pip3`` **inside** the virtual environment,
whereas invocation of ``pip3`` directly uses your **system** ``pip3`` instance,
typically located in ``/usr/bin/pip3``