This repo contains the documentation source for: https://docs.foundries.io
Currently the docs are written in reStucturedText with Sphinx serving as the site generator.
Before beginning any work, be sure to review CONTRIBUTING.md.
In order to build documentation, at minimum both python3 and pip for python3 are
required. All required python modules are described in requirements.txt in this
directory and can be installed withpip install -r requirements.txt.
The following is the list of packages needed (can be incomplete):
| Package |
|---|
| sphinx |
| sphinx-rtd-theme |
| sphinx-tabs |
| sphinxemoji |
| sphinx_copybutton |
| sphinxcontrib.asciinema |
| sphinxcontrib-contentui |
| sphinx_toolbox |
| sphinx-prompt |
| myst-parser |
The recommended way to build documentation (in order to avoid messing with
global system-wide package storage) is to use virtualenv to set up the
necessary environment for sphinx packages:
$ sudo apt-get install python3 python3-virtualenv
$ virtualenv -p /usr/bin/python3 venv
$ . ./venv/bin/activate
$ pip install -r requirements.txt
To build html from rst files run from the top directory:
$ make html
you can then open build/html/index.html in your browser to view the
documentation.