Skip to content

Commit

Permalink
update latest sphinx for python versions that support it + ignore pro…
Browse files Browse the repository at this point in the history
…blem link anchors while validating pages themselves
  • Loading branch information
fmigneault committed Jul 7, 2023
1 parent 8a61c02 commit 61dc3e8
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Fixes:
(see https://github.com/python-jsonschema/jsonschema/blob/main/CHANGELOG.rst#v4180,
https://python-jsonschema.readthedocs.io/en/v4.18.0/api/jsonschema/validators/#jsonschema.validators._RefResolver
and `python-jsonschema/jsonschema#1049 <https://github.com/python-jsonschema/jsonschema/pull/1049>`_).
- Fix multiple linting checks, documentation dependencies and link references.

.. _changes_4.30.0:

Expand Down
9 changes: 5 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -432,8 +432,6 @@ def doc_redirect_include(file_path):
# following have sporadic downtimes
"https://esgf-data.dkrz.de/",
"https://indico.egi.eu/",
# ignore anchors not found although valid
"https://spec.openapis.org/oas/v3.1.0/*#*",
".*docker-registry.crim.ca.*", # protected
# might not exist yet (we are generating it!)
"https://pavics-weaver.readthedocs.io/en/latest/api.html",
Expand All @@ -445,8 +443,11 @@ def doc_redirect_include(file_path):
"https://ogc-ades.crim.ca/.*",
"https://ogc.crim.ca/.*",
"https://github.com/.*\\.rst#.*",
# GitHub anchors causing problems
"https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object",
]
linkcheck_anchors_ignore = [
"xml-object", # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
"data-types", # https://spec.openapis.org/oas/v3.1.0
"defusedxmllxml", # https://github.com/tiran/defusedxml/tree/main
]

linkcheck_timeout = 30
Expand Down
3 changes: 2 additions & 1 deletion requirements-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
-r requirements.txt
cloud_sptheme
jinja2<3.1 # fix sphinx failing, see: https://github.com/sphinx-doc/sphinx/issues/10291
sphinx>=3.5,<6
sphinx>=3.5,<6; python_version <= "3.7"
sphinx>=6,<8; python_version >= "3.8"
sphinx-argparse
sphinx-autoapi>=1.7.0
sphinx-paramlinks>=0.4.1
Expand Down
2 changes: 0 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ cryptography
# (https://github.com/common-workflow-language/common-workflow-language/issues/587)
### git+https://github.com/crim-ca/cwltool@docker-gpu#egg=cwltool; python_version >= "3"
cwltool==3.1.20230213100550
# defused required for json2xml
defusedxml
docker
duration
esgf-compute-api @ git+https://github.com/ESGF/esgf-compute-api.git@v2.3.7
Expand Down
2 changes: 1 addition & 1 deletion weaver/xml_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
instead, because that package's extension with :mod:`lxml` is marked as deprecated.
.. seealso::
https://pypi.org/project/defusedxml/#defusedxml-lxml
https://github.com/tiran/defusedxml/tree/main#defusedxmllxml
To use the module, import is as if importing :mod:`lxml.etree`:
Expand Down

0 comments on commit 61dc3e8

Please sign in to comment.