David Williams
ee299a45f0
Work on error handling. I replaced some asserts with exceptions and also added basic error handling documentation.
2013-05-11 10:05:08 +02:00
Matt Williams
60826b4c85
Add documentation and a tutorial for the Python bindings
...
This should cover most questions about the Python bindings but of course,
some things in the bindings is still subject to change.
2013-04-16 23:18:16 +01:00
unknown
17827fe8a6
Tidying up documentation files.
2012-09-11 00:20:42 +02:00
unknown
8ccfb46d97
Re-added Matt's changes which I deleted by mistake.
2012-09-10 22:40:44 +02:00
unknown
9949aa6881
Added a big chunk of documentation.
2012-09-09 22:56:51 +02:00
Matt Williams
73c900f4ae
A few small fixes to the documentation.
2012-09-06 16:11:18 +01:00
Matt Williams
5c888f8d03
Include the changelog in the manual
2012-06-26 17:09:20 +01:00
David Williams
5adabf624a
Added missing files.
2010-08-21 13:13:39 +00:00
David Williams
6d58348297
Updated basic example and associated documentation.
2010-08-21 11:55:15 +00:00
Matt Williams
b127adfab8
Tweak some spelling and add some links
2010-07-27 14:31:49 +00:00
Matt Williams
d45604c80b
Make manual
depend on doc
.
...
Tweak some Sphinx/CMake stuff.
2010-07-20 13:24:28 +00:00
Matt Williams
5cbd0981eb
Use the simper :doc: role over the :ref: role.
2010-07-16 09:10:33 +00:00
Matt Williams
9a19866cbe
Add some examples of using the doxylink extension.
...
Add a documentation/install.rst which pulls in the content of INSTALL.txt
2010-07-15 17:21:19 +00:00
Matt Williams
5e62a35f42
Add a CMakeLists.txt which provides the 'manual' target for building the Sphinx documentation. This may require you to set the SPHINXBUILD_EXECUTABLE CMake variable to the sphinx-build executable
...
Change the file extension to 'rst' rather than 'txt' to avoid clashes with CMakeLists.txt and to help syntax highlighting.
Add the doxylink Sphinx extension from sphinx-contrib to provide Doxygen links.
2010-07-14 10:31:15 +00:00