FOSS Flow For FPGA
Go to file
Tim Ansell 5cf83d7bfb
Merge pull request #196 from antmicro/add_readme
Add basic README for documentation
2020-04-01 09:45:44 -07:00
doxygen Add support for documenting C++ with Sphinx 2019-10-18 09:44:31 +02:00
source Merge pull request #233 from SymbiFlow/dependabot/submodules/source/symbiflow-arch-defs-e1281bb 2020-04-01 01:33:26 +00:00
.gitignore Overwriting old documentation without DCO 2019-04-05 07:56:47 -07:00
.gitmodules Replace VPR abstract with official VPR documentation 2019-09-25 21:50:21 +02:00
COPYING Adding missing ISC license file 2019-11-20 11:29:06 -08:00
Makefile Separate conda and sphinx build directories 2020-02-26 10:50:23 +01:00
README.rst Add basic README for documentation 2020-03-18 11:15:10 +01:00
enter-env.sh Enable conda environment support 2019-10-16 18:45:52 +00:00
environment.yml Add Symbolator for generating symbols of verilog models 2019-10-21 13:35:45 +00:00
readthedocs.yml Check out submodules recursively 2019-10-17 12:27:12 +00:00
requirements.txt Add missing extensions and exclude patterns 2020-03-27 18:47:04 +01:00

README.rst

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