diff --git a/.github/workflows/branch-man.yml b/.github/workflows/branch-man.yml index c197f1d2..99e0f807 100644 --- a/.github/workflows/branch-man.yml +++ b/.github/workflows/branch-man.yml @@ -26,8 +26,8 @@ jobs: - name: Install Python packages run: > pip3 install dnspython beautifulsoup4 pyxdg requests \ - sphinx sphinx_epytext sphinx_rtd_theme sphinx-intl \ - setuptools_scm + sphinx sphinx_epytext sphinx_rtd_theme sphinx-sitemap \ + sphinx-intl setuptools_scm - name: Prepare git environment run: | diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 994faefe..b7d819b7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -102,7 +102,8 @@ jobs: - name: Install Python packages run: | - pip install -r requirements.txt Sphinx sphinx-epytext sphinx-intl sphinx-rtd-theme + pip install -r requirements.txt Sphinx sphinx-epytext sphinx-intl \ + sphinx-rtd-theme sphinx-sitemap - name: Build run: | diff --git a/.github/workflows/publish-pages.yml b/.github/workflows/publish-pages.yml index bb48001b..43a5472d 100644 --- a/.github/workflows/publish-pages.yml +++ b/.github/workflows/publish-pages.yml @@ -28,7 +28,7 @@ jobs: - name: Install Python packages run: > pip install dnspython beautifulsoup4 pyxdg requests \ - sphinx sphinx_epytext sphinx_rtd_theme + sphinx sphinx_epytext sphinx_rtd_theme sphinx-sitemap - name: Build run: | diff --git a/doc/documentation.md b/doc/documentation.md index d2dacb22..6209bb3e 100644 --- a/doc/documentation.md +++ b/doc/documentation.md @@ -14,6 +14,8 @@ sphinx_epytext sphinx_rtd_theme +sphinx_sitemap + Configuration ------------- diff --git a/doc/src/conf.py b/doc/src/conf.py index 2d27be15..e8b802ce 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -22,6 +22,7 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinx_epytext', 'sphinx_rtd_theme', + 'sphinx_sitemap', ] locale_dirs = ['../i18n/locales'] @@ -81,6 +82,13 @@ extlinks = {'pypi': ('https://pypi.org/project/%s/', '')} graphviz_output_format = 'svg' +# sitemap +html_baseurl = 'https://linkchecker.github.io/linkchecker/' + +sitemap_locales = [None] + +sitemap_url_scheme = "{link}" + # -- Mock -------------------------------------------------------------------- import linkcheck.logger