From caa7efcfb90b9ef66cfbb13ae451cb43f3ad1bef Mon Sep 17 00:00:00 2001
From: Dhruva Gowda Storz <dhruvastorz@gmail.com>
Date: Tue, 12 Dec 2017 15:40:17 +0530
Subject: [PATCH] Recovered quickstart section in html, added tutorials
placeholder and implemented rudimentary integration between doxygen and
sphinx (dependecy on breathe sphinx extension)
---
docs/source/conf.py | 16 +++++++++++++++-
docs/source/index.rst | 1 +
docs/source/user/py/quickstart/index_qs.rst | 15 +++++++++++++++
.../user/py/quickstart/moose_quickstart.rst | 2 +-
docs/source/user/py/tutorials/index_tut.rst | 4 ++++
5 files changed, 36 insertions(+), 2 deletions(-)
create mode 100644 docs/source/user/py/quickstart/index_qs.rst
create mode 100644 docs/source/user/py/tutorials/index_tut.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
index f3d787c8..2af96f47 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 aa463b19..2795b479 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 00000000..c75b441d
--- /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 a446b679..e41c9c33 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 00000000..c6003754
--- /dev/null
+++ b/docs/source/user/py/tutorials/index_tut.rst
@@ -0,0 +1,4 @@
+Tutorials
+=========
+
+Insert Tutorials here.
--
GitLab