Skip to content

How to build Sverchok documentation with images included

Ilya V. Portnov edited this page Jan 12, 2020 · 1 revision

Start from the docs/ directory in Sverchok repo

$ cd docs/
$ python3 download_images.py

Wait for some time... It has to download all images from github. After it's done, go back to the root directory of the repository and run the script (it currently exists for Unix-based systems only, but one can write similar for Windows):

$ cd ..
$ ./build_docs.sh

As a result, you will have docs/_build/sverchok_documentation.tar.bz2 file, containing HTML documentation with all images included.

Note that download_images.py modifies documentation rst files in place (to update links to images). Please do not push these changes to github!.

Clone this wiki locally