diff --git a/vizro-ai/.readthedocs.yaml b/vizro-ai/.readthedocs.yaml index 50675a2d8..843460cb0 100644 --- a/vizro-ai/.readthedocs.yaml +++ b/vizro-ai/.readthedocs.yaml @@ -11,6 +11,8 @@ build: python: "3.11" commands: - pip install hatch - - cd vizro-ai/ && hatch run docs:build && hatch run docs:link-check + - cd vizro-ai/ && hatch run docs:pip freeze + - cd vizro-ai/ && hatch run docs:build + - cd vizro-ai/ && hatch run docs:link-check - mkdir --parents $READTHEDOCS_OUTPUT - mv vizro-ai/site/ $READTHEDOCS_OUTPUT/html diff --git a/vizro-ai/changelog.d/20240619_105033_antony.milne_fix_docs.md b/vizro-ai/changelog.d/20240619_105033_antony.milne_fix_docs.md new file mode 100644 index 000000000..f1f65e73c --- /dev/null +++ b/vizro-ai/changelog.d/20240619_105033_antony.milne_fix_docs.md @@ -0,0 +1,48 @@ + + + + + + + + + diff --git a/vizro-ai/hatch.toml b/vizro-ai/hatch.toml index daa68982c..28e274955 100644 --- a/vizro-ai/hatch.toml +++ b/vizro-ai/hatch.toml @@ -49,6 +49,7 @@ dependencies = [ "mkdocs-material", "mkdocs-git-revision-date-localized-plugin", "mkdocstrings[python]", + "mkdocstrings-python<1.10.4", "linkchecker" ] detached = true @@ -58,7 +59,7 @@ build = "mkdocs build --strict" # Disable warnings on the linkcheck so that HTTP redirects are accepted. We could ignore only that warning and specify # more advanced settings using a linkcheckerrc config file. openai.com doesn't seem to work well with linkchecking, # throwing 403 errors, but these are not real errors. -link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1 --ignore-url=https://platform.openai.com/docs/models --ignore-url=openai.com --ignore-url=https://openai.com/" +link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1 --ignore-url=https://vizro.readthedocs.io/ --ignore-url=https://platform.openai.com/docs/models --ignore-url=openai.com --ignore-url=https://openai.com/" serve = "mkdocs serve --strict" [envs.lint] diff --git a/vizro-core/.readthedocs.yaml b/vizro-core/.readthedocs.yaml index 4282838d3..9d217e8f2 100644 --- a/vizro-core/.readthedocs.yaml +++ b/vizro-core/.readthedocs.yaml @@ -11,6 +11,8 @@ build: python: "3.11" commands: - pip install hatch - - cd vizro-core/ && hatch run docs:build && hatch run docs:link-check + - cd vizro-core/ && hatch run docs:pip freeze + - cd vizro-core/ && hatch run docs:build + - cd vizro-core/ && hatch run docs:link-check - mkdir --parents $READTHEDOCS_OUTPUT - mv vizro-core/site/ $READTHEDOCS_OUTPUT/html diff --git a/vizro-core/changelog.d/20240619_102218_antony.milne_fix_docs.md b/vizro-core/changelog.d/20240619_102218_antony.milne_fix_docs.md new file mode 100644 index 000000000..f1f65e73c --- /dev/null +++ b/vizro-core/changelog.d/20240619_102218_antony.milne_fix_docs.md @@ -0,0 +1,48 @@ + + + + + + + + + diff --git a/vizro-core/hatch.toml b/vizro-core/hatch.toml index 51760c11b..1d00bc10f 100644 --- a/vizro-core/hatch.toml +++ b/vizro-core/hatch.toml @@ -68,6 +68,7 @@ dependencies = [ "mkdocs-material", "mkdocs-git-revision-date-localized-plugin", "mkdocstrings[python]", + "mkdocstrings-python<1.10.4", "linkchecker" ] detached = true @@ -76,7 +77,7 @@ detached = true build = "mkdocs build --strict" # Disable warnings on the linkcheck so that HTTP redirects are accepted. We could ignore only that warning and specify # more advanced settings using a linkcheckerrc config file. -link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1" +link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1 --ignore-url=https://vizro.readthedocs.io/" serve = "mkdocs serve --strict" [envs.lint]