From af48e80a274c15e70169d3d4b823d5d58d7dc3a0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 12 Dec 2022 13:01:09 +0000 Subject: [PATCH] Automated template update from cookiecutter-scverse (#64) * Automated template update from cookiecutter-scverse * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix merge conflict Co-authored-by: grst Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Gregor Sturm --- .cruft.json | 4 ++-- docs/_templates/autosummary/class.rst | 2 ++ docs/conf.py | 3 ++- docs/developer_docs.md | 3 ++- pyproject.toml | 1 + 5 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.cruft.json b/.cruft.json index e13da47..45b02f3 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/scverse/cookiecutter-scverse", - "commit": "28f47a97470826ca5000df24fd272e0d32d1c6fa", + "commit": "c96cadaa981a71113cc97ada8e5085188ed22ed7", "context": { "cookiecutter": { "project_name": "infercnvpy", @@ -19,5 +19,5 @@ } }, "directory": null, - "checkout": "v0.0.3" + "checkout": "v0.1.1" } diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst index 49f45ed..17dc123 100644 --- a/docs/_templates/autosummary/class.rst +++ b/docs/_templates/autosummary/class.rst @@ -38,6 +38,7 @@ Attributes ~~~~~~~~~~~ {% for item in attributes %} + {{ item }} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -54,6 +55,7 @@ Methods {% for item in methods %} {%- if item != '__init__' %} + {{ item }} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/conf.py b/docs/conf.py index a693321..0c124cf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,7 @@ author = info["Author"] copyright = f"{datetime.now():%Y}, {author}." version = info["Version"] -repository_url = "https://github.com/" + "grst" + "/" + project_name +repository_url = f"https://github.com/grst/{project_name}" # The full version, including alpha/beta/rc tags release = info["Version"] @@ -53,6 +53,7 @@ "sphinxcontrib.bibtex", "sphinx_autodoc_typehints", "sphinx.ext.mathjax", + "IPython.sphinxext.ipython_console_highlighting", *[p.stem for p in (HERE / "extensions").glob("*.py")], ] diff --git a/docs/developer_docs.md b/docs/developer_docs.md index 4d1c9f1..5a468e7 100644 --- a/docs/developer_docs.md +++ b/docs/developer_docs.md @@ -193,7 +193,8 @@ In addition to the packages needed to _use_ this package, you need additional py the documentation_. It's easy to install them using `pip`: ```bash -pip install "infercnvpy[dev,test,doc]" +cd infercnvpy +pip install -e ".[dev,test,doc]" ``` ### Code-style diff --git a/pyproject.toml b/pyproject.toml index cf25e77..2056529 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,6 +32,7 @@ dependencies = [ 'pyreadr', # for debug logging (referenced from the issue template) "session-info", + "ipython" ] [project.optional-dependencies]