summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-01-13 14:14:10 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-01-13 14:14:10 +0000
commit9d773455130bfa7bcdd6d6566f46d7a3cb1d984e (patch)
tree3f1e5778ae45083d9474b2fd7f39d767011683b1 /docs
parentcd2de102b93a46c3249d88e46d811dd1fa625b66 (diff)
include autogenerated commands section in manual
to generate the commands, got to /docs/user/ and hit `make generate_commands`, which will overwrite the file /docs/user/source/usage/commands.rst which will be included in the next run of `make html`.
Diffstat (limited to 'docs')
-rw-r--r--docs/user/Makefile3
-rw-r--r--docs/user/source/usage/commands.rst0
-rw-r--r--docs/user/source/usage/index.rst5
3 files changed, 7 insertions, 1 deletions
diff --git a/docs/user/Makefile b/docs/user/Makefile
index f7e52045..29be0741 100644
--- a/docs/user/Makefile
+++ b/docs/user/Makefile
@@ -34,7 +34,8 @@ help:
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
generate_commands:
- python source/generate_commands.py > source/commands.rst
+ python source/generate_commands.py > source/usage/commands.rst
+
clean:
-rm -rf $(BUILDDIR)/*
diff --git a/docs/user/source/usage/commands.rst b/docs/user/source/usage/commands.rst
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/user/source/usage/commands.rst
diff --git a/docs/user/source/usage/index.rst b/docs/user/source/usage/index.rst
index f8fc11d3..b9e3db73 100644
--- a/docs/user/source/usage/index.rst
+++ b/docs/user/source/usage/index.rst
@@ -10,3 +10,8 @@ First Steps
===========
.. include:: first_steps.rst
+
+Commands
+========
+
+.. include:: commands.rst