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)

Requirements (system):

• docker
• git

To create the custom docker image (with python and its dependencies):

docker build -t spinaldoc-rtd .

Then to build the docs:

docker run -it --rm -v $PWD:/docs spinaldoc-rtd

You can still run custom commands in the docker, for instance to clean:

docker run -it --rm -v $PWD:/docs spinaldoc-rtd make clean

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

git clone https://github.com/SpinalHDL/SpinalDoc-RTD.git --branch gh-pages deploy_tmp
rm -rf deploy_tmp/*
cp -r docs/html/* deploy_tmp/
cd deploy_tmp/
git add --all
git commit -am "deploy"
git push
cd ..
rm -rf deploy_tmp

This repo use Travis for his CI needs. If you want have a gh-pages preview on your fork, you need to activate your repo on Travis admin page. After that you only need add GITHUB_TOKEN as Environment Variable with your Github personal token (you only need grant repo/public_repo access) More details here:

• Defining variables
• Deploy to gh-pages