From ac8f0c96ae46db2c3481ac837c7a5832bff63424 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 12:04:11 -0500 Subject: [PATCH 1/5] Add Github CI doc job --- .github/workflows/ci.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fc7e99b..fcfd149 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -71,4 +71,21 @@ jobs: curl -L -O -k https://gitlab.tiker.net/inducer/ci-support/raw/master/build-and-test-py-project.sh . ./build-and-test-py-project.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 -- GitLab From a315e7dd83a46e44ce22a58c34b599c9020cbf2e Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 12:04:19 -0500 Subject: [PATCH 2/5] Gitlab CI doc job: run for all branches --- .gitlab-ci.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index aae441a..9b9500c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -48,6 +48,4 @@ Documentation: - ". ./build-docs.sh" tags: - python3 - only: - - master -- GitLab From 6a87d6a84e7aa799e480762fe005b0e8627b726e Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 12:04:43 -0500 Subject: [PATCH 3/5] Document type variables in pytools --- pytools/__init__.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/pytools/__init__.py b/pytools/__init__.py index 585d4b8..b7dc098 100644 --- a/pytools/__init__.py +++ b/pytools/__init__.py @@ -153,6 +153,17 @@ Sorting in natural order .. autofunction:: natorder .. autofunction:: natsorted + +Type Variables Used +------------------- + +.. class:: T + + Any type. + +.. class:: F + + Any callable. """ # {{{ type variables -- GitLab From db83930535cb2771720f4d6b0a143ad8153537d9 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 12:04:54 -0500 Subject: [PATCH 4/5] Remove non-present function compute_topological_order_v2 from pytools.graph docs --- pytools/graph.py | 1 - 1 file changed, 1 deletion(-) diff --git a/pytools/graph.py b/pytools/graph.py index a00fe31..c9ce84a 100644 --- a/pytools/graph.py +++ b/pytools/graph.py @@ -35,7 +35,6 @@ Graph Algorithms .. autofunction:: compute_sccs .. autoclass:: CycleError .. autofunction:: compute_topological_order -.. autofunction:: compute_topological_order_v2 .. autofunction:: compute_transitive_closure .. autofunction:: contains_cycle .. autofunction:: compute_induced_subgraph -- GitLab From a3eb52427415b62529d361c27ee812521c456ce4 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Wed, 26 Aug 2020 12:05:20 -0500 Subject: [PATCH 5/5] Fix doc references in obj_array --- pytools/obj_array.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pytools/obj_array.py b/pytools/obj_array.py index 509f158..f0e5f24 100644 --- a/pytools/obj_array.py +++ b/pytools/obj_array.py @@ -131,7 +131,7 @@ def obj_array_vectorize(f, ary): .. note :: - This function exists because :func:`numpy.vectorize` suffers from the same + This function exists because :class:`numpy.vectorize` suffers from the same issue described under :func:`make_obj_array`. """ @@ -158,7 +158,7 @@ def rec_obj_array_vectorize(f, ary): .. note :: - This function exists because :func:`numpy.vectorize` suffers from the same + This function exists because :class:`numpy.vectorize` suffers from the same issue described under :func:`make_obj_array`. """ if isinstance(ary, np.ndarray) and ary.dtype.char == "O": @@ -186,7 +186,7 @@ def obj_array_vectorize_n_args(f, *args): .. note :: - This function exists because :func:`numpy.vectorize` suffers from the same + This function exists because :class:`numpy.vectorize` suffers from the same issue described under :func:`make_obj_array`. """ oarray_arg_indices = [] -- GitLab