Conversation
- Switch doc links to `stable` slug. - In Makefile, don't init `SOURCEDIR` and `VENVDIR` variables if they already exist at run time. This lets projects override these dirs in parent build scripts.
* fix: remove redundancy in sitemap_url_scheme PR #462 introduced fetching the canonical URL from a RTD environment variable. In versioned docs, this URL includes the version, which means that the previous logic to set the sitemap_url_scheme is no longer necessary and duplicates the version (e.g., "../latest/latest/.."). This fix removes the duplication. Since the html_baseurl value falls back to "/", there is also no need to set a separate sitemap_url_scheme for local builds. * doc: update sitemaps how-to guide and changelog Updates sitemaps how-to guide to reflect changes to how html_baseurl is generated and sitemap_url_scheme is set. Updates changelog to reflect removal of duplicate version strings in sitemaps. Signed-off-by: Minae Lee <minae.lee@canonical.com>
chore: update dev with latest release
`VALEDIR` represents the package directory for Vale, yet it re-establishes the same path as `VENVDIR`. It makes more sense to compose it from `VENVDIR`. Furthermore, since `VENVDIR` is configurable by the calling environment, it stands to reason that `VALEDIR` should be, too.
The site https://canonical-example-product-documentation.readthedocs-hosted.com/ was recently deleted. This commit removes all links and references to that site. It also updates its use in demonstrating intersphinx use in the documentation with example syntax instead of a real link to protect against future link rot. Note that the deleted site has been temporarily re-created to prevent build failures from numerous sites that link to it. However, this is only a temporarily measure and those sites should also update their links to avoid future issues. Signed-off-by: Minae Lee <minae.lee@canonical.com>
The build environment has several variables with popular names such as `BUILDDIR` and `SOURCEDIR`. These can confuse developers of projects where the docs aren't at the root, and could collide with their root build systems. - Remove old var names. - Make variables more consistent: - `DOCS_` for vars specific to the docs build. - `<tool>_` for tool-specific vars, such as `VALE_DIR`. - Reorganise the list of vars. This further helps projects that call the Makefile from a root build system.
* ci: revert change to reusable workflow * docs: add documentation-checks input reference
Fixes #470. --------- Co-authored-by: Dave Wilding <tech@dpw.me>
medubelko
requested review from
SecondSkoll,
akcano,
dwilding,
minaelee,
rkratky and
tang-mm
as code owners
Collaborator
Author
|
Pinging @jahn-junior and @minaelee to have a look. :) |
jahn-junior
requested changes
Feb 20, 2026
Collaborator
Author
|
Needs a rebase now. |
minaelee
approved these changes
Feb 20, 2026
minaelee
left a comment
minaelee
left a comment
There was a problem hiding this comment.
Re-requested my own review because I became concerned about the linter failures. Then I realized that the #508 fix in main should resolve it, so nvm! The linkcheck failure should also resolve in main, and the CLA check is just an intermittent issue. LGTM again :)
Collaborator
Author
That will be incorporated when I rebase. :) |
medubelko
force-pushed
the
merge/dev
branch
2 times, most recently
from
3ce7055 to
d2256dc
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The main work prior to dismissing the
devbranch.Additional commits are to correct the docs and changelog.
CHANGELOG.mdwith relevant non-documentation file changes?