diff --git a/docs/source/conf.py b/docs/source/conf.py index f3d787c8d8f668d52c5df341e587151d8e9eeb0e..2af96f470f15a85a6eca6ef9ab314a6411368ee7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,6 +27,7 @@ sys.path.append(os.path.abspath('../../moose-examples/tutorials/ChemicalBistable sys.path.append(os.path.abspath('../../moose-examples/tutorials/ExcInhNet')) sys.path.append(os.path.abspath('../../moose-examples/neuroml/lobster_pyloric')) sys.path.append(os.path.abspath('../../moose-examples/tutorials/ExcInhNetCaPlasticity')) +sys.path.append('../../docproj/ext/breathe/') # -- General configuration ----------------------------------------------------- @@ -41,6 +42,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.todo', 'sphinx.ext.viewcode', + 'breathe' ] todo_include_todos = True @@ -110,6 +112,8 @@ todo_include_todos = True # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] +sys.setrecursionlimit(2000) + # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -286,4 +290,14 @@ import subprocess, os read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: - subprocess.call('cd ../../doxygen; echo HELLO......................; doxygen Doxyfile', shell=True) + subprocess.call('cd ../../source/doxygen; echo HELLO......................; doxygen Doxyfile', shell=True) + +#####################Breathe########################## + +breathe_projects = { + 'src':'doxygen/cpp/xml' + } + +breathe_default_project = 'index' + + diff --git a/docs/source/index.rst b/docs/source/index.rst index aa463b195ce811c66214430238e874299d41f6ea..2795b47965ffe8da70a0ac49dc8286bcc7de9201 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -27,6 +27,7 @@ MOOSE is a simulation environment, not just a numerical engine: It provides data /install/index_install /user/py/quickstart/index_qs + /user/py/tutorials/index_tut /user/py/cookbook/index_ckbk /user/py/graphics/index_graphics /user/py/references/index_ref diff --git a/docs/source/user/py/quickstart/index_qs.rst b/docs/source/user/py/quickstart/index_qs.rst new file mode 100644 index 0000000000000000000000000000000000000000..c75b441d2b44c1bb44d586ff115a765d74b323e7 --- /dev/null +++ b/docs/source/user/py/quickstart/index_qs.rst @@ -0,0 +1,15 @@ +.. MOOSE documentation master file, created by + sphinx-quickstart on Tue Jul 1 19:05:47 2014. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Quick Start +=========== + +.. toctree:: + :maxdepth: 2 + + qs_GUI + moose_quickstart + demos + classes_demos diff --git a/docs/source/user/py/quickstart/moose_quickstart.rst b/docs/source/user/py/quickstart/moose_quickstart.rst index a446b679fe69ccdd4bfac9add3761a4d35140adf..e41c9c338607f0befb4ca56e006dec149d5f1a9c 100644 --- a/docs/source/user/py/quickstart/moose_quickstart.rst +++ b/docs/source/user/py/quickstart/moose_quickstart.rst @@ -34,7 +34,7 @@ Contents: :maxdepth: 2 :numbered: - moose_quickstart + Indices and tables ================== diff --git a/docs/source/user/py/tutorials/index_tut.rst b/docs/source/user/py/tutorials/index_tut.rst new file mode 100644 index 0000000000000000000000000000000000000000..c6003754d5f14780c5971e9fe606345a5aa88354 --- /dev/null +++ b/docs/source/user/py/tutorials/index_tut.rst @@ -0,0 +1,4 @@ +Tutorials +========= + +Insert Tutorials here.