Skip to content

Commit 1431d14

Browse files
committed
doc fixes
1 parent c8564a2 commit 1431d14

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Tests
9090
API documentation
9191
-----------------
9292

93-
.. include:: ../../pySDC/README.rst
93+
.. include:: ../../pySDC/README_API.rst
9494

9595
.. toctree::
9696
:maxdepth: 1

pySDC/README.rst

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,5 @@ Many implementations of e.g. sweepers, data types or problems can be found in ``
44
These contain the specialized ingredients for a user-defined setup, e.g. an LU-based MLSDC run for the generalized Fisher's equation with Gauss-Radau nodes.
55
In ``helpers``, we can find helper functions used by the core routines, the implementations or by the user.
66

7-
The Python files contained in these three packages are fully documented and their API is generated automatically with sphinx-apidoc after each update.
8-
The API (as well as the tutorial pages) can also be generated manually and locally by executing
9-
10-
.. code-block:: none
11-
12-
> ./docs/update_apidocs.sh
13-
> nosetests tests -v --with-id --with-coverage --cover-inclusive --cover-package=pySDC,tutorial --cover-html --cover-html-dir=target/doc/build/test_coverage
14-
> travis-sphinx build
15-
16-
in the root directory. Then, the main index can be found in ``target/doc/build/index.html``. Anyway, here is the online version:
17-
7+
Then, in ``playgrounds`` there are various small to medium experiments done with pySDC. They are for example grouped by application (e.g. ``Boris``) or by problem type (e.g. ``ODEs``).
8+
In ``projects`` we gather focussed experiments with pySDC which go beyond simple toy problems or feature tests, while ``tutorial`` contains the files and data for the tutorial codes.

pySDC/README_API.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
The Python files contained in ``core``, ``implementations`` and ``helpers`` are fully documented and their API is generated automatically with sphinx-apidoc after each update.
2+
The API (as well as the tutorial pages) can also be generated manually and locally by executing
3+
4+
.. code-block:: none
5+
6+
> ./docs/update_apidocs.sh
7+
> 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/
8+
> travis-sphinx build
9+
10+
in the root directory. Then, the main index can be found in ``target/doc/build/index.html``. Anyway, here is the online version:
11+

0 commit comments

Comments
 (0)