FOSS Flow For FPGA
Go to file
Unai Martinez-Corral 6be52fd7e7 rename 'source' to 'docs'
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-21 19:50:03 +01:00
.github/workflows s/SymbiFlow/F4PGA/ 2022-02-21 18:39:03 +01:00
docs rename 'source' to 'docs' 2022-02-21 19:50:03 +01:00
third_party Bump third_party/make-env from `0696632` to `59adb0f` 2021-04-16 05:36:52 +00:00
.gitignore rename 'source' to 'docs' 2022-02-21 19:50:03 +01:00
.gitmodules use intersphinx instead of adding submodules 2022-02-10 04:14:26 +01:00
LICENSE relicense to Apache-2.0 2022-02-21 17:49:38 +01:00
Makefile rename 'source' to 'docs' 2022-02-21 19:50:03 +01:00
README.rst Update README after setting make-env 2020-09-16 16:39:05 +02:00
environment.yml rename 'source' to 'docs' 2022-02-21 19:50:03 +01:00
readthedocs.yml rename 'source' to 'docs' 2022-02-21 19:50:03 +01:00
requirements.txt theme: use variant 'chips' 2022-02-21 17:49:38 +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``