fix(rtd): Correct documentation rendering in rtd.

vinci1it2000 · Nov 4, 2020 · 5b108d7 · 5b108d7
1 parent d5c1b19
commit 5b108d7
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -57,7 +57,9 @@ coverage.xml
 *.log
 
 # Sphinx documentation
-docs/_build/
+doc/_build/
+doc/toctree/
+
 
 # PyBuilder
 target/

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1,3 +1,4 @@
+.. _start-contrib:
 Contributing to schedula
 ========================
 
@@ -57,7 +58,8 @@ Well done! Your contribution is ready to be submitted:
 - Once the *pull request* is approved and merged you can pull the changes from
   ``upstream`` to your local repo and delete your extra branch(es).
 
-
+.. _end-contrib:
+.. _start-donate:
 Donate
 ======
 
@@ -67,3 +69,5 @@ development please donate.
 .. raw:: html
 
     <script src="https://donorbox.org/widget.js" paypalExpress="false"></script><iframe src="https://donorbox.org/embed/schedula?amount=25&show_content=true" height="685px" width="100%" style="max-width:100%; min-width:100%; max-height:none!important" seamless="seamless" name="donorbox" frameborder="0" scrolling="no" allowpaymentrequest></iframe>
+
+.. _end-donate:
diff --git a/README.rst b/README.rst
@@ -324,7 +324,7 @@ If you want to visualize the latest workflow of the dispatcher, you can use the
 ``workflow=True``:
 
 .. dispatcher:: dsp
-   :opt: index=True, workflow=True
+   :opt: index=True, workflow=True, engine='fdp'
    :code:
 
     >>> dsp.plot(workflow=True, index=True)  # doctest: +SKIP

diff --git a/doc/conf.py b/doc/conf.py
@@ -141,6 +141,7 @@
     html_theme = 'sphinx_rtd_theme'
     # Add any paths that contain custom themes here, relative to this directory.
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+    extensions.append('readthedocs_ext.readthedocs')
 
 # 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/doc/contrib.rst b/doc/contrib.rst
@@ -1 +1,3 @@
-.. include:: ../CONTRIBUTING.rst
+.. include:: ../CONTRIBUTING.rst
+    :start-after: .. _start-contrib:
+    :end-before: .. _end-contrib:
diff --git a/doc/donate.rst b/doc/donate.rst
@@ -0,0 +1,3 @@
+.. include:: ../CONTRIBUTING.rst
+    :start-after: .. _start-donate:
+    :end-before: .. _end-donate:
diff --git a/doc/index.rst b/doc/index.rst
@@ -22,6 +22,7 @@
     tutorial
     async
     contrib
+    donate
     api
     change
 

diff --git a/requirements/dev.pip b/requirements/dev.pip
@@ -5,5 +5,6 @@ wheel
 gitchangelog
 mako
 sphinx_rtd_theme
+readthedocs-sphinx-ext
 setuptools>=36.0.1
 sphinxcontrib-restbuilder
diff --git a/schedula/__init__.py b/schedula/__init__.py
@@ -16,7 +16,7 @@
 
 .. autosummary::
     :nosignatures:
-    :toctree: _build/schedula
+    :toctree: toctree/schedula
 
     ~dispatcher
     ~utils

diff --git a/setup.py b/setup.py
@@ -92,7 +92,7 @@ def get_long_description(cleanup=True):
     extras['dev'] = extras['all'] + [
         'wheel', 'sphinx', 'gitchangelog', 'mako', 'sphinx_rtd_theme',
         'setuptools>=36.0.1', 'sphinxcontrib-restbuilder', 'nose', 'coveralls',
-        'requests'
+        'requests', 'readthedocs-sphinx-ext'
     ]
 
     setup(