From: Martin Quinson <martin.quinson@loria.fr>
Date: Mon, 30 Jul 2018 20:07:48 +0000 (+0200)
Subject: Get the documentation to build on RTD
X-Git-Tag: v3_21~357
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/4309be0ed30c43d7891492ebf52b2579ce420d66?ds=sidebyside

Get the documentation to build on RTD
---

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 0000000000..ec93a97bed
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,5 @@
+# Path to the pip requirements file
+requirements_file: docs/requirements.txt
+    
+# Don't build any extra formats
+formats: []
\ No newline at end of file
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 512e3c0ae8..340741439d 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -1371,7 +1371,7 @@ MAN_LINKS              = NO
 # generate an XML file that captures the structure of
 # the code including all documentation.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 #---------------------------------------------------------------------------
 # configuration options for the AutoGen Definitions output
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000000..cd6467ed82
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1 @@
+breathe
diff --git a/docs/source/conf.py b/docs/source/conf.py
index ce87e70902..a8113dfff4 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -40,13 +40,14 @@ release = u'3.21'
 # ones.
 extensions = [
 #    'sphinx.ext.coverage',
-#    'sphinx.ext.mathjax',
+    'sphinx.ext.mathjax',
 #    'sphinx.ext.ifconfig',
     'breathe',
 ]
 
 breathe_projects = { 'simgrid': '../doc/xml' }
-
+breathe_default_project = "simgrid"
+ 
 # highlight_language = 'c++'
 # todo_include_todos = False
 
@@ -84,7 +85,6 @@ pygments_style = 'sphinx'
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
-# alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 904a569561..f20d9aefee 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -9,7 +9,7 @@ Welcome to SimGrid's documentation!
 
 	What is SimGrid <main_concepts.rst>
 	Installing SimGrid <installation.rst>
-	Create your own project <install_yours.rst>
+	Start your Own Project <install_yours.rst>
 
 
 Indices and tables