From 577594873de51c648da615a53575cc5a986e19c5 Mon Sep 17 00:00:00 2001 From: Robpol86 Date: Sat, 28 Sep 2024 23:12:13 -0400 Subject: [PATCH] sitemap --- docs/conf.py | 3 ++- poetry.lock | 25 +++++++++++++++++++++---- pyproject.toml | 1 + 3 files changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0ab273df..469717eb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,6 +23,7 @@ "sphinx.ext.extlinks", "sphinx.ext.intersphinx", "sphinx_imgur.imgur", # https://sphinx-imgur.readthedocs.io + "sphinx_sitemap", # https://github.com/jdillard/sphinx-sitemap "sphinxcontrib.youtube", # https://github.com/sphinx-contrib/youtube "ablog", # https://ablog.readthedocs.io/ ] @@ -165,6 +166,7 @@ .. _Read The Docs: https://readthedocs.org/ .. _Alabaster: https://github.com/bitprophet/alabaster """ +sitemap_url_scheme = "{link}" def parse_event(env, sig, signode): @@ -217,7 +219,6 @@ def setup(app): * Revisit pyproject.toml * Revisit GitHub Actions * robots.txt and .htaccess -* sitemap.xml * 404 page * log 404s and confirm me visiting bad pages logs correctly * apple favicons diff --git a/poetry.lock b/poetry.lock index 86cd57e3..d758d519 100644 --- a/poetry.lock +++ b/poetry.lock @@ -311,13 +311,13 @@ files = [ [[package]] name = "dill" -version = "0.3.8" +version = "0.3.9" description = "serialize all of Python" optional = false python-versions = ">=3.8" files = [ - {file = "dill-0.3.8-py3-none-any.whl", hash = "sha256:c36ca9ffb54365bdd2f8eb3eff7d2a21237f8452b57ace88b1ac615b7e815bd7"}, - {file = "dill-0.3.8.tar.gz", hash = "sha256:3ebe3c479ad625c4553aca177444d89b486b1d84982eeacded644afc0cf797ca"}, + {file = "dill-0.3.9-py3-none-any.whl", hash = "sha256:468dff3b89520b474c0397703366b7b95eebe6303f108adf9b19da1f702be87a"}, + {file = "dill-0.3.9.tar.gz", hash = "sha256:81aa267dddf68cbfe8029c42ca9ec6a4ab3b22371d1c450abc54422577b4512c"}, ] [package.extras] @@ -1379,6 +1379,23 @@ sphinx = "*" [package.extras] docs = ["sphinx-copybutton", "sphinx-notfound-page", "sphinx-panels", "sphinx-rtd-theme", "sphinxext-opengraph", "toml"] +[[package]] +name = "sphinx-sitemap" +version = "2.6.0" +description = "Sitemap generator for Sphinx" +optional = false +python-versions = "*" +files = [ + {file = "sphinx_sitemap-2.6.0-py3-none-any.whl", hash = "sha256:7478e417d141f99c9af27ccd635f44c03a471a08b20e778a0f9daef7ace1d30b"}, + {file = "sphinx_sitemap-2.6.0.tar.gz", hash = "sha256:5e0c66b9f2e371ede80c659866a9eaad337d46ab02802f9c7e5f7bc5893c28d2"}, +] + +[package.dependencies] +sphinx = ">=1.2" + +[package.extras] +dev = ["build", "flake8", "pre-commit", "pytest", "sphinx", "tox"] + [[package]] name = "sphinxcontrib-applehelp" version = "2.0.0" @@ -1848,4 +1865,4 @@ type = ["pytest-mypy"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "05ad96c1466c9e86cefeaa0c70a7db4826b947dc6915cabb559c295c003eb6ba" +content-hash = "2672999fff2f17371214e3c23a6151daf5af462c99b4de7851e45c8b62e3b0ca" diff --git a/pyproject.toml b/pyproject.toml index 04f672df..a20dd0d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,6 +26,7 @@ sphinx = "*" sphinx-book-theme = "*" sphinx-copybutton = "*" sphinx-imgur = "*" +sphinx-sitemap = "*" sphinxcontrib-youtube = "*" [tool.poetry.group.dev]