many bugfixes for documentation

Author: pancetta

.travis.yml

@@ -26,7 +26,7 @@ script:
   - "./docs/update_apidocs.sh"
   - mkdir data
   - which nosetests
-  - nosetests --with-coverage --cover-inclusive --cover-package=core,implementation,helpers,tutorial --cover-html --cover-html-dir=target/doc/build/test_coverage pySDC/
+  - nosetests --with-coverage --cover-erase --cover-inclusive --cover-package=pySDC/core,pySDC/implementations,pySDC/helpers,pySDC/tutorial --cover-html --cover-html-dir=target/doc/build/test_coverage pySDC/tests
   - if [[ $PYTHON_VERSION == 3 ]]; then travis-sphinx build; fi
 
 after_success:

docs/source/conf.py

@@ -22,6 +22,7 @@
 sys.path.insert(0, os.path.abspath('../'))
 sys.path.insert(0, os.path.abspath('../../'))
 sys.path.insert(0, os.path.abspath('../../../'))
+sys.path.insert(0, os.path.abspath('../../pySDC'))
 
 # -- General configuration ------------------------------------------------
 

docs/source/index.rst

@@ -55,13 +55,13 @@ Tutorial
 .. toctree::
    :maxdepth: 1
 
-   pySDC/tutorial/step_1.rst
-   pySDC/tutorial/step_2.rst
-   pySDC/tutorial/step_3.rst
-   pySDC/tutorial/step_4.rst
-   pySDC/tutorial/step_5.rst
-   pySDC/tutorial/step_6.rst
-   pySDC/tutorial/step_7.rst
+   tutorial/step_1.rst
+   tutorial/step_2.rst
+   tutorial/step_3.rst
+   tutorial/step_4.rst
+   tutorial/step_5.rst
+   tutorial/step_6.rst
+   tutorial/step_7.rst
 
 Playgrounds
 -----------
@@ -75,11 +75,11 @@ Projects
 .. toctree::
    :maxdepth: 2
 
-   pySDC/projects/parallelSDC.rst
-   pySDC/projects/node_failure.rst
-   pySDC/projects/fwsw.rst
-   pySDC/projects/asymp_conv.rst
-   pySDC/projects/RDC.rst
+   projects/parallelSDC.rst
+   projects/node_failure.rst
+   projects/fwsw.rst
+   projects/asymp_conv.rst
+   projects/RDC.rst
 
 Tests
 -----
@@ -95,9 +95,9 @@ API documentation
 .. toctree::
    :maxdepth: 1
 
-   pySDC/pySDC.core.rst
-   pySDC/pySDC.implementations.rst
-   pySDC/pySDC.helpers.rst
+   pySDC/core.rst
+   pySDC/implementations.rst
+   pySDC/helpers.rst
 
 
 Indices and tables

docs/update_apidocs.sh

@@ -21,8 +21,7 @@ rm -r ${PWD}/target/doc/build
 
 echo ""
 echo "generating new .rst files ..."
-${SPHINX_APIDOC} -o docs/source/pySDC/core pySDC/core --force -M -T
-${SPHINX_APIDOC} -o docs/source/pySDC/implementations pySDC/implementations --force -M -T
-${SPHINX_APIDOC} -o docs/source/pySDC/helpers pySDC/helpers --force -M -T
-#${SPHINX_APIDOC} -o docs/source/pySDC pySDC --force -M -T
+${SPHINX_APIDOC} -o docs/source/pySDC pySDC/core --force -T
+${SPHINX_APIDOC} -o docs/source/pySDC pySDC/implementations --force -T
+${SPHINX_APIDOC} -o docs/source/pySDC pySDC/helpers --force -T
 rm docs/source/pySDC/pySDC.rst

pySDC/README_API.rst

@@ -4,7 +4,7 @@ The API (as well as the tutorial pages) can also be generated manually and local
 .. code-block:: none
 
    > ./docs/update_apidocs.sh
-   > nosetests -v --with-id --with-coverage --cover-inclusive --cover-package=core,implementations,helpers,tutorial --cover-html --cover-html-dir=target/doc/build/test_coverage pySDC/
+   > nosetests -v --with-id --with-coverage --cover-inclusive --cover-package=core,implementations,helpers,tutorial --cover-html --cover-html-dir=target/doc/build/test_coverage pySDC/tests
    > travis-sphinx build
 
 in the root directory. Then, the main index can be found in ``target/doc/build/index.html``. Anyway, here is the online version: