Skip to content

Fix broken links, customize Makefile variables #468

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
medubelko merged 2 commits into from
Nov 17, 2025
Merged

Fix broken links, customize Makefile variables #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
017da67
Fix broken links
akcano Nov 14, 2025
572d96b
Make SOURCEDIR, VENVDIR conditional
akcano Nov 14, 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
4 changes: 2 additions & 2 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
SPHINXDIR = .sphinx
SPHINXOPTS ?= -c . -d $(SPHINXDIR)/.doctrees -j auto
SPHINXBUILD ?= $(VENVDIR)/bin/sphinx-build
SOURCEDIR = .
SOURCEDIR ?= .
BUILDDIR = _build
VENVDIR = $(SPHINXDIR)/venv
VENVDIR ?= $(SPHINXDIR)/venv
PA11Y = $(SPHINXDIR)/node_modules/pa11y/bin/pa11y.js --config $(SPHINXDIR)/pa11y.json
VENV = $(VENVDIR)/bin/activate
TARGET = *
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to/contributing-myst.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,9 @@ TODO: test command 2

## Documentation

ACME's documentation is stored in the `DOCDIR` directory of the repository. It is based on the [Canonical starter pack](https://canonical-starter-pack.readthedocs-hosted.com/latest/) and hosted on [Read the Docs](https://about.readthedocs.com/).
ACME's documentation is stored in the `DOCDIR` directory of the repository. It is based on the [Canonical starter pack](https://canonical-starter-pack.readthedocs-hosted.com/stable/) and hosted on [Read the Docs](https://about.readthedocs.com/).

For general guidance, refer to the [starter pack guide](https://canonical-starter-pack.readthedocs-hosted.com/latest/).
For general guidance, refer to the [starter pack guide](https://canonical-starter-pack.readthedocs-hosted.com/stable/).

For syntax help and guidelines, refer to the syntax guides contained in the [rST](project:#style-guide) and [MyST](project:#myst_style_guide) syntax guides.

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Documentation

ACME's documentation is stored in the ``DOCDIR`` directory of the repository.
It is based on the `Canonical starter pack
<https://canonical-starter-pack.readthedocs-hosted.com/latest/>`_
<https://canonical-starter-pack.readthedocs-hosted.com/stable/>`_
and hosted on `Read the Docs <https://about.readthedocs.com/>`_.

For syntax help and guidelines,
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to/set-up-sitemaps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ For instance, using the starter pack as an example, with three versions

Disallow: # Allow everything

Sitemap: https://canonical-starter-pack.readthedocs-hosted.com/latest/sitemapindex.xml
Sitemap: https://canonical-starter-pack.readthedocs-hosted.com/stable/sitemapindex.xml

3. Create a ``sitemapindex.xml`` file, in the same directory as your configuration
file, which points to the sitemap files of each of your documentation sets:
Expand All @@ -169,7 +169,7 @@ For instance, using the starter pack as an example, with three versions

<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<sitemap>
<loc>https://canonical-starter-pack.readthedocs-hosted.com/latest/sitemap.xml</loc>
<loc>https://canonical-starter-pack.readthedocs-hosted.com/stable/sitemap.xml</loc>
</sitemap>
<sitemap>
<loc>https://canonical-starter-pack.readthedocs-hosted.com/3.0/sitemap.xml</loc>
Expand Down
Loading