Skip to content
Snippets Groups Projects
Commit caa7efcf authored by Dhruva Gowda Storz's avatar Dhruva Gowda Storz
Browse files

Recovered quickstart section in html, added tutorials placeholder and...

Recovered quickstart section in html, added tutorials placeholder and implemented rudimentary integration between doxygen and sphinx (dependecy on breathe sphinx extension)
parent 3d961280
No related branches found
No related tags found
2 merge requests!233Documentation update 2,!225Documentation update #1
......@@ -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'
......@@ -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
......
.. 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
......@@ -34,7 +34,7 @@ Contents:
:maxdepth: 2
:numbered:
moose_quickstart
Indices and tables
==================
......
Tutorials
=========
Insert Tutorials here.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment