2016-03-05 20:42:05 +03:00
|
|
|
Building the docs
|
|
|
|
|
=================
|
|
|
|
|
|
2016-08-26 15:05:40 +03:00
|
|
|
First install Sphinx and the RTD theme:
|
2016-03-05 20:42:05 +03:00
|
|
|
|
2021-05-26 16:51:43 +03:00
|
|
|
make venv
|
2016-03-05 20:42:05 +03:00
|
|
|
|
2016-03-12 12:15:44 +03:00
|
|
|
or update it if already installed:
|
2016-03-05 20:42:05 +03:00
|
|
|
|
2021-05-26 16:51:43 +03:00
|
|
|
make venv-upgrade
|
2016-03-05 20:42:05 +03:00
|
|
|
|
2016-03-12 12:15:44 +03:00
|
|
|
Go to the docs folder:
|
2016-03-05 20:42:05 +03:00
|
|
|
|
2016-03-12 12:15:44 +03:00
|
|
|
cd docs
|
|
|
|
|
|
|
|
|
|
Then build the HTML documentation:
|
2016-03-05 20:42:05 +03:00
|
|
|
|
2016-03-12 12:15:44 +03:00
|
|
|
make html
|
|
|
|
|
|
|
|
|
|
and the man page:
|
|
|
|
|
|
2016-03-12 17:34:33 +03:00
|
|
|
LC_ALL=C make man
|
