FOSS Flow For FPGA
Find a file
Unai Martinez-Corral 61a62b6eb5 conf: cleanup
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-10 04:14:27 +01:00
.github/workflows
doxygen
source conf: cleanup 2022-02-10 04:14:27 +01:00
third_party
.gitignore
.gitmodules
COPYING
environment.yml
Makefile
README.rst
readthedocs.yml
requirements.txt

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

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

Activate the virtual environment and install dependencies::

    make env
    make enter

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``