From 69be96e24e659ea4b9b5a543d061dff7f8864bdf Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 10:41:50 -0500 Subject: [PATCH 1/7] Doc: disable html static path --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 386b1a8..0506e22 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 -- GitLab From 3891a60d9a1e2c8a29dadf2b3d95235ac319bb6d Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 10:42:13 -0500 Subject: [PATCH 2/7] Document Adams function families --- leap/multistep/__init__.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/leap/multistep/__init__.py b/leap/multistep/__init__.py index 4674cf6..53279ca 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 -- GitLab From aff6263c167a23cb7ed7f18473e441de6fb44006 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 10:42:30 -0500 Subject: [PATCH 3/7] Run Gitlab CI doc job for all branches --- .gitlab-ci.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 2d18c7f..0cfb37a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -45,8 +45,6 @@ Documentation: - ". ./build-docs.sh" tags: - python3 - only: - - master Flake8: script: -- GitLab From 2014b9c2be91c2c3a7f0058207d2c534f90f2bb1 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 10:42:56 -0500 Subject: [PATCH 4/7] Add Github CI doc job --- .github/workflows/ci.yml | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fde641a..d1ac57b 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,17 @@ 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 + - 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_conda_env + build_docs + # vim: sw=4 -- GitLab From faa3c7822949a2f6e7138e42e79756094926d702 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 10:43:08 -0500 Subject: [PATCH 5/7] Fix ReST IMEX doc markup in --- leap/rk/imex.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/leap/rk/imex.py b/leap/rk/imex.py index b4884b9..e11d40c 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 """ -- GitLab From ee33ba814eac0b28d2793e3b831839daac3c0710 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 10:48:36 -0500 Subject: [PATCH 6/7] Use venv for Github doc job --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d1ac57b..15bc923 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -91,7 +91,7 @@ jobs: 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_conda_env + build_py_project_in_venv build_docs # vim: sw=4 -- GitLab From ccd8c034234f7e0ede99cdd43b4f1611919eb4bd Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 10:52:12 -0500 Subject: [PATCH 7/7] Add Python setup for Github doc job --- .github/workflows/ci.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 15bc923..bc72845 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -86,6 +86,10 @@ jobs: 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" -- GitLab