/VexiiRiscv-RTD

Primary LanguagePythonCreative Commons Zero v1.0 UniversalCC0-1.0

SpinalDoc

This is the documentation repository for VexiiRiscv.

It is published on spinalhdl.github.io/VexiiRiscv-RTD.

How to build this documentation

With venv

Requirements (system)

  • make
  • git

Create a virtual environment with pipenv (will use the Pipfile for installing the necessary packages)

python3 -m venv .venv

then you can activate the virtual enviroment (in bash) and install the dependencies

source .venv/bin/activate
pip install -r requirements.txt

and then you can use make the usual way

make html     # for html
make latex    # for latex
make latexpdf # for latex (will require latexpdf installed)
make          # list all the available output format

all the outputs will be in docs folder (for html: docs/html)

Native

Requirements (system):

  • make
  • git

Requirements (Python 3):

  • sphinx
  • sphinx-rtd-theme
  • sphinxcontrib-wavedrom
  • sphinx-multiversion

After installing the requirements you can run

make html     # for html
make latex    # for latex
make latexpdf # for latex (will require latexpdf installed)
make          # list all the available output format

you can create build multiple version of the doc via

sphinx-multiversion source docs/html

in the docs/html there will be a folder with the builded doc for each branch and tag