FOSS Flow For FPGA
Go to file
Unai Martinez-Corral 5ff23d9042 gitignore: update
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-10 04:14:32 +01:00
.github/workflows ci: add GitHub Actions workflow 'Doc' 2022-02-10 04:14:22 +01:00
source conf: cleanup 2022-02-10 04:14:27 +01:00
third_party Bump third_party/make-env from `0696632` to `59adb0f` 2021-04-16 05:36:52 +00:00
.gitignore gitignore: update 2022-02-10 04:14:32 +01:00
.gitmodules use intersphinx instead of adding submodules 2022-02-10 04:14:26 +01:00
COPYING Adding missing ISC license file 2019-11-20 11:29:06 -08:00
Makefile Setup build environment using make-env 2020-09-16 15:41:36 +02:00
README.rst Update README after setting make-env 2020-09-16 16:39:05 +02:00
environment.yml environment: cleanup 2022-02-10 04:14:31 +01:00
readthedocs.yml Check out submodules recursively 2019-10-17 12:27:12 +00:00
requirements.txt requirements: cleanup 2022-02-10 04:14:28 +01:00

README.rst

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