tAdded separate rst files for python api and c++ ckass reference - sphere - GPU… | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit 780f5a4ad608633cea970558ab0a2fad0f749f87 | |
parent ff6db42f125b2038673acdfd3a9c0da60f243498 | |
Author: Anders Damsgaard Christensen <[email protected]> | |
Date: Tue, 4 Dec 2012 20:48:46 +0100 | |
Added separate rst files for python api and c++ ckass reference | |
Diffstat: | |
M doc/sphinx/conf.py | 12 ++++++++++-- | |
A doc/sphinx/cpp.rst | 6 ++++++ | |
M doc/sphinx/index.rst | 16 ++++++++++++++-- | |
A doc/sphinx/python_api.rst | 5 +++++ | |
4 files changed, 35 insertions(+), 4 deletions(-) | |
--- | |
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py | |
t@@ -12,12 +12,18 @@ | |
# serve to show the default. | |
import sys, os | |
+import breathe | |
+ | |
+print("Python version: " + sys.version) | |
# If extensions (or modules to document with autodoc) are in another directory, | |
# add these directories to sys.path here. If the directory is relative to the | |
# documentation root, use os.path.abspath to make it absolute, like shown here. | |
#sys.path.insert(0, os.path.abspath('.')) | |
+# Include the python directory with the sphere module to the python path | |
+sys.path.insert(0, os.path.abspath('../../python/')) | |
+ | |
# -- General configuration ---------------------------------------------------… | |
# If your documentation needs a minimal Sphinx version, state it here. | |
t@@ -26,7 +32,9 @@ import sys, os | |
# Add any Sphinx extension module names here, as strings. They can be extensio… | |
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
#extensions = [] | |
-extensions = ['sphinx.ext.autodoc'] | |
+extensions = ['sphinx.ext.autodoc','breathe'] | |
+breathe_projects = { "sphere": "../doxygen/xml/" } | |
+breathe_default_project = "sphere" | |
# Add any paths that contain templates here, relative to this directory. | |
templates_path = ['_templates'] | |
t@@ -121,7 +129,7 @@ html_theme = 'default' | |
# Add any paths that contain custom static files (such as style sheets) here, | |
# relative to this directory. They are copied after the builtin static files, | |
# so a file named "default.css" will overwrite the builtin "default.css". | |
-html_static_path = ['_static'] | |
+#html_static_path = ['_static'] | |
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
# using the given strftime format. | |
diff --git a/doc/sphinx/cpp.rst b/doc/sphinx/cpp.rst | |
t@@ -0,0 +1,6 @@ | |
+C++ reference | |
+============= | |
+.. doxygenclass:: DEM | |
+ :members: | |
+ | |
+ | |
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst | |
t@@ -5,14 +5,26 @@ | |
Welcome to sphere's documentation! | |
================================== | |
+This is the official documentation for the *sphere* discrete element modelling… | |
+ | |
+*sphere* is developed by Anders Damsgaard Christensen under supervision of Dav… | |
+ | |
+Contact: Anders Damsgaard Christensen, http://cs.au.dk/~adc, [email protected] | |
+ | |
Contents: | |
.. toctree:: | |
:maxdepth: 2 | |
- intro | |
- tutorial | |
+ introduction | |
+ python_api | |
+ cpp | |
+ | |
+ | |
+Introduction | |
+============ | |
+ | |
diff --git a/doc/sphinx/python_api.rst b/doc/sphinx/python_api.rst | |
t@@ -0,0 +1,5 @@ | |
+Python API | |
+========== | |
+.. automodule:: sphere | |
+ :members: | |
+ |