diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2019-05-12 12:11:30 +0100 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2019-05-12 12:11:30 +0100 |
| commit | 758fc8aa80c414c6f9f68624613e1bb7bc142ff9 (patch) | |
| tree | 7737c92d95d030784eb93454b2537b5192601214 /docs | |
| parent | 8786eb008b07b02f080d4253e629c38699e21610 (diff) | |
docs: add note regarding docs generation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/installation.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 488211df..116e96c0 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -60,3 +60,14 @@ A man page can be generated using:: make -C docs man Both will end up in their respective subfolders in :file:`docs/build`. + +In order to remove the command docs and automatically re-generate them from inline docstrings, use the make target `cleanall`, as in:: + + make -C docs cleanall html + +.. note:: On Debian you need to overide the variable `PYTHON` used in the makefile + so that it uses "python3", not "python", which by default links to + version 2.7* of the interpreter. + :: + + make PYTHON="python3" -C docs cleanall html |