Fix mkdocs site_url and don't use directory urls (#651)

* Customize 404 and don't use directory urls

* Change site_url

* Dynamically set url

* Fix syntax

* Separate commands

* Remove unnecessary override

* Cross-platform sed command

* Apply suggested improvement to config

Co-authored-by: Chuck Daniels <[email protected]>

---------

Co-authored-by: Chuck Daniels <[email protected]>

Author: maxrjones

.pre-commit-config.yaml

@@ -8,6 +8,7 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
+        exclude: mkdocs.yml
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.

.readthedocs.yml

@@ -12,8 +12,3 @@ build:
     - pixi install --environment docs
     - pixi run build-docs
     - pixi run readthedocs
-
-# Build documentation in the doc/ directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-  fail_on_warning: true

mkdocs.yml

@@ -4,8 +4,9 @@ repo_name: zarr-developers/VirtualiZarr
 repo_url: https://github.com/zarr-developers/VirtualiZarr
 site_description: Cloud-Optimize your Scientific Data as Virtual Zarr stores, using Xarray syntax.
 site_author: VirtualiZarr developers
-site_url: https://virtualizarr.readthedocs.io/en/stable/index.html
+site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://virtualizarr.readthedocs.io/en/latest/']
 docs_dir: docs
+use_directory_urls: false
 
 extra:
   version:

pyproject.toml

@@ -201,8 +201,7 @@ docs = ["docs"]
 serve-docs = { cmd = "mkdocs serve" }
 build-docs = { cmd = "mkdocs build" }
 check-docs = { cmd = "mkdocs build --strict" }
-readthedocs = "rm -rf $READTHEDOCS_OUTPUT/html && cp -r site $READTHEDOCS_OUTPUT/html"
-
+readthedocs = { cmd = "rm -rf $READTHEDOCS_OUTPUT/html && cp -r site $READTHEDOCS_OUTPUT/html" }
 # Define commands to run within the docs environment
 [tool.pixi.feature.minio.tasks]
 run-tests = { cmd = "pytest virtualizarr/tests/test_manifests/test_store.py virtualizarr/tests/test_parsers/test_hdf/test_hdf_manifest_store.py --run-minio-tests --run-network-tests --verbose" }