diff options
Diffstat (limited to 'docs/README.txt')
-rw-r--r-- | docs/README.txt | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/README.txt b/docs/README.txt new file mode 100644 index 00000000..06491bcd --- /dev/null +++ b/docs/README.txt @@ -0,0 +1,22 @@ +Building the docs +================= + +First install Sphinx: + + pip install sphinx + +or update it if already installed: + + pip install --upgrade sphinx + +Go to the docs folder: + + cd docs + +Then build the HTML documentation: + + make html + +and the man page: + + LC_ALL=C make man |