Skip to content

Clarify instructions for sitemaps #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SecondSkoll merged 3 commits into from
Jun 10, 2025
Merged

Clarify instructions for sitemaps #395

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6cd146
Clarify instructions for sitemaps
s-makin Jun 9, 2025
1e617ab
fix spelling error
s-makin Jun 9, 2025
8f0866b
Update docs/how-to/set-up-sitemaps.rst
s-makin Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/how-to/set-up-sitemaps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ configuration file. For example, in :file:`docs/conf.py`:

html_baseurl = 'https://canonical-starter-pack.readthedocs-hosted.com/'

Make sure to include the trailing slash (``/``) to avoid errors in the concatenated
URLs in the sitemap.

.. note::

Sitemap configuration is included in the Starter pack's
Expand All @@ -44,12 +47,15 @@ Optional sitemap configuration
------------------------------

Sphinx sitemap uses a configurable URL scheme to set language and version options
for your documentation. Default configuration provided by the starter pack uses:
for your documentation. If you have no languages and no versions in your URL, add
the following to your ``conf.py`` file:

.. code-block::

sitemap_url_scheme = "{link}"

Note that this is the default configuration provided by the starter pack.

To add versioning, this can be done manually, or you can read the version from
the RTD instance. To implement a manual version:

Expand Down
Loading