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

docs: set site_url to fix broken 404 page on RTD #5

Merged
merged 2 commits into from
Jul 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
site_name: Stub Generator
repo_url: https://github.com/Safe-DS/Stub-Generator
repo_name: Safe-DS/Stub-Generator
edit_uri: edit/main/docs/
site_url: !ENV READTHEDOCS_CANONICAL_URL

nav:
- Home:
Expand Down
22 changes: 15 additions & 7 deletions readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,21 @@ build:
os: ubuntu-22.04
tools:
python: '3.10'
jobs:
# https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry
post_create_environment:
- pip install poetry
- poetry config virtualenvs.create false
post_install:
- poetry install --with docs
commands:
- pip install poetry
- poetry config virtualenvs.create false
- poetry install --with docs
- cat mkdocs.yml
- mkdocs build --clean --site-dir $READTHEDOCS_OUTPUT/html --config-file mkdocs.yml
# Once https://github.com/readthedocs/readthedocs.org/issues/8529 is fixed, replace the commands above with the
# following to use the default RTD build steps again:
# jobs:
# # https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry
# post_create_environment:
# - pip install poetry
# - poetry config virtualenvs.create false
# post_install:
# - poetry install --with docs

mkdocs:
configuration: mkdocs.yml