Skip to content
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.

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

build(docs): set site_url from ReadTheDocs env var #13685

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Oct 1, 2024

Motivation

  • site_url is required for canonicalization and creating a sitemap.xml

  • Also for certain features like:

Modifications

  • Add site_url config to mkdocs.yml

Verification

tbd still need to test this

- `site_url` is [required](https://stackoverflow.com/a/59295885/3431180) for canonicalization and creating a `sitemap.xml`

- Also for certain features like:
  - Instant loading: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=site+url#instant-loading
  - Versioning (we use RTD's versioning, but may want some features from here): https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/?h=site+url#publishing-a-new-version

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/build Build or GithubAction/CI issues labels Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant