Skip to content

Commit

Permalink
docs: set site_url to fix broken 404 page on RTD (#450)
Browse files Browse the repository at this point in the history
### Summary of Changes

The 404 page was previously not properly rendered on Read the Docs
(RTD). This PR overrides the build commands of RTD. While this makes the
404 page work properly, it also removes the RTD flyout to select a
version. For now, however, we deem the 404 page as more essential.

Once readthedocs/readthedocs.org#8529 is done,
we can use the default build again to make everything work as expected.

---------

Co-authored-by: megalinter-bot <129584137+megalinter-bot@users.noreply.github.com>
  • Loading branch information
lars-reimann and megalinter-bot authored Jul 11, 2023
1 parent 545e035 commit ea2ca6a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
site_name: Safe-DS DSL
repo_url: https://github.com/Safe-DS/DSL
repo_name: Safe-DS/DSL
edit_uri: edit/main/docs/
site_url: !ENV READTHEDOCS_CANONICAL_URL

nav:
- Home:
Expand Down
14 changes: 10 additions & 4 deletions readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ build:
os: ubuntu-22.04
tools:
python: '3.10'
commands:
- python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
- python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
- cat mkdocs.yml
- mkdocs build --clean --site-dir $READTHEDOCS_OUTPUT/html --config-file mkdocs.yml

mkdocs:
configuration: mkdocs.yml

python:
install:
- requirements: docs/requirements.txt
# 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:
#python:
# install:
# - requirements: docs/requirements.txt

0 comments on commit ea2ca6a

Please sign in to comment.