From a7f0d9e6a3a29d059fa7df33a4d7801519b654d1 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 12:12:35 +0000 Subject: [PATCH 1/8] Update instance repo from cookiecutter template --- docs/conf.py | 5 +++++ pyproject.toml | 1 + 2 files changed, 6 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 1e182cd..f269979 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,6 +29,10 @@ # The full version, including alpha/beta/rc tags release = info["Version"] +# Opengraph information: https://sphinxext-opengraph.readthedocs.io/ +ogp_site_url = "https://cookiecutter-scverse-instance.readthedocs.io/" +ogp_enable_meta_description = True + bibtex_bibfiles = ["references.bib"] templates_path = ["_templates"] nitpicky = True # Warn about broken links @@ -57,6 +61,7 @@ "sphinx_autodoc_typehints", "sphinx.ext.mathjax", "IPython.sphinxext.ipython_console_highlighting", + "sphinxext.opengraph", *[p.stem for p in (HERE / "extensions").glob("*.py")], ] diff --git a/pyproject.toml b/pyproject.toml index 0f3724c..cc26c91 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,6 +36,7 @@ doc = [ "myst-nb", "sphinxcontrib-bibtex>=1.0.0", "sphinx-autodoc-typehints", + "sphinxext-opengraph", # For notebooks "ipykernel", "ipython", From 01a4bbac26c27e3ce99d1a942706748bc0e0faf3 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 12:13:29 +0000 Subject: [PATCH 2/8] Update instance repo from cookiecutter template --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index f269979..4d26ce3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,7 @@ release = info["Version"] # Opengraph information: https://sphinxext-opengraph.readthedocs.io/ -ogp_site_url = "https://cookiecutter-scverse-instance.readthedocs.io/" +ogp_site_url = urls["Documentation"] ogp_enable_meta_description = True bibtex_bibfiles = ["references.bib"] From 1179d38b378a0df6aa274a7ff5cb979c9386642d Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 12:23:58 +0000 Subject: [PATCH 3/8] Update instance repo from cookiecutter template --- docs/conf.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4d26ce3..e2a9ecc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,10 +29,6 @@ # The full version, including alpha/beta/rc tags release = info["Version"] -# Opengraph information: https://sphinxext-opengraph.readthedocs.io/ -ogp_site_url = urls["Documentation"] -ogp_enable_meta_description = True - bibtex_bibfiles = ["references.bib"] templates_path = ["_templates"] nitpicky = True # Warn about broken links From af32dec5234293c3ec8e6793f50292f377b5489c Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 12:45:23 +0000 Subject: [PATCH 4/8] Update instance repo from cookiecutter template --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index e2a9ecc..2f46af3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -108,7 +108,7 @@ # a list of builtin themes. # html_theme = "sphinx_book_theme" -html_static_path = ["_static"] +html_static_path = ["_static", "_images"] html_title = project_name html_theme_options = { From ed86dcb2cd9ef96dc2bea8af1fd210c254afbf7e Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 13:06:18 +0000 Subject: [PATCH 5/8] Update instance repo from cookiecutter template --- docs/conf.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2f46af3..a9075eb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -108,7 +108,7 @@ # a list of builtin themes. # html_theme = "sphinx_book_theme" -html_static_path = ["_static", "_images"] +html_static_path = ["_static"] html_title = project_name html_theme_options = { @@ -139,3 +139,8 @@ def setup(app): }, True, ) + + # TEMP + from subcommand import run + + app.connect("build-finished", lambda app, exc: run(["tree", app.outdir])) From 27df8028b31ce2b1b3aa2b5ba4f4c53dc4ffd008 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 13:11:18 +0000 Subject: [PATCH 6/8] Update instance repo from cookiecutter template --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index a9075eb..81c6893 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -141,6 +141,6 @@ def setup(app): ) # TEMP - from subcommand import run + from subprocess import run app.connect("build-finished", lambda app, exc: run(["tree", app.outdir])) From 52f3305effd793779ac0001f7b4f6d59103bcd9c Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 13:20:48 +0000 Subject: [PATCH 7/8] Update instance repo from cookiecutter template --- docs/conf.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 81c6893..62bcf56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -141,6 +141,4 @@ def setup(app): ) # TEMP - from subprocess import run - - app.connect("build-finished", lambda app, exc: run(["tree", app.outdir])) + app.connect("build-finished", lambda app, exc: print(*sorted(Path(app.outdir).glob("**/*")), sep="\n")) From 4eab099ec328f38344729c35c9f890ed47390f95 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jun 2023 13:39:00 +0000 Subject: [PATCH 8/8] Update instance repo from cookiecutter template --- docs/conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 62bcf56..e2a9ecc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -139,6 +139,3 @@ def setup(app): }, True, ) - - # TEMP - app.connect("build-finished", lambda app, exc: print(*sorted(Path(app.outdir).glob("**/*")), sep="\n"))