diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fde641ae99f0f75e01bd649042618723eb6b6d1b..bc7284514e954010d2cb72832a82451e96fa3ca6 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,7 +18,7 @@ jobs: - uses: actions/setup-python@v1 with: - python-version: '3.x' + python-version: '3.x' - name: "Main Script" run: | curl -L -O -k https://gitlab.tiker.net/inducer/ci-support/raw/master/prepare-and-run-flake8.sh @@ -32,7 +32,7 @@ jobs: - uses: actions/setup-python@v1 with: - python-version: '3.x' + python-version: '3.x' - name: "Main Script" run: | EXTRA_INSTALL="matplotlib scipy" @@ -81,4 +81,21 @@ jobs: curl -L -O -k https://gitlab.tiker.net/inducer/ci-support/raw/master/build-py-project-and-run-examples.sh . ./build-py-project-and-run-examples.sh + docs: + name: Documentation + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - + uses: actions/setup-python@v1 + with: + python-version: '3.x' + - name: "Main Script" + run: | + EXTRA_INSTALL="numpy" + curl -L -O -k https://gitlab.tiker.net/inducer/ci-support/raw/master/ci-support.sh + . ci-support.sh + build_py_project_in_venv + build_docs + # vim: sw=4 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 2d18c7fce8392bb3c4c0de2adf2992fb441918f5..0cfb37a9a4e6d0114861136c77d8a5496bdf97c1 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -45,8 +45,6 @@ Documentation: - ". ./build-docs.sh" tags: - python3 - only: - - master Flake8: script: diff --git a/doc/conf.py b/doc/conf.py index 386b1a8ef032901866deb4edf94dad685686bbc8..0506e221027d35effeca2af17ee5272d61f08aa2 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -149,7 +149,7 @@ html_sidebars = { # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/leap/multistep/__init__.py b/leap/multistep/__init__.py index 4674cf6faf2340419c5a967f7bd20684e5e184df..53279caf4353c0f4ed93abc8af8a3a78a0ec4286 100644 --- a/leap/multistep/__init__.py +++ b/leap/multistep/__init__.py @@ -36,6 +36,8 @@ from pymbolic import var __doc__ = """ +.. autoclass:: AdamsIntegrationFunctionFamily +.. autoclass:: AdamsMonomialIntegrationFunctionFamily .. autoclass:: AdamsBashforthMethodBuilder """ @@ -50,6 +52,14 @@ def _linear_comb(coefficients, vectors): class AdamsIntegrationFunctionFamily(object): + """An abstract interface for function families used for + Adams-type time integration. + + .. automethod:: __len__ + .. automethod:: evaluate + .. automethod:: antiderivative + """ + def __len__(self): raise NotImplementedError() @@ -61,6 +71,9 @@ class AdamsIntegrationFunctionFamily(object): class AdamsMonomialIntegrationFunctionFamily(AdamsIntegrationFunctionFamily): + """ + Implements :class:`AdamsMonomialIntegrationFunctionFamily`. + """ def __init__(self, order): self.order = order diff --git a/leap/rk/imex.py b/leap/rk/imex.py index b4884b964ae986aac10e67e59a3c45df7b7a2814..e11d40cd437c0379eeae2a9301621268c2795de9 100644 --- a/leap/rk/imex.py +++ b/leap/rk/imex.py @@ -35,8 +35,8 @@ THE SOFTWARE. __doc__ = """ -IMEX MethodBuilders ------------- +IMEX Method Builders +-------------------- .. autoclass :: KennedyCarpenterIMEXRungeKuttaMethodBuilderBase """