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

[GEOT-7154] Sphinx build failure with extlinks (new warnings in Sphinx build) #3910

Merged
merged 3 commits into from May 31, 2022

Conversation

aaime
Copy link
Member

@aaime aaime commented May 30, 2022

GEOT-7154 Powered by Pull Request Badge

@jodygarnett could you have a quick look? Sphinx came up with a new warning that was not there before.

Checklist

For core and extension modules:

  • New unit tests have been added covering the changes.
  • Documentation has been updated (if change is visible to end users).
  • There is an issue in GeoTools Jira (except for changes not visible to end users).
  • Commit message(s) must be in the form [GEOT-XYZW] Title of the Jira ticket.
  • Bug fixes and small new features are presented as a single commit.
  • The commit targets a single objective (if multiple focuses cannot be avoided, each one is in its own commit, and has a separate ticket describing it).

@aaime aaime requested a review from jodygarnett May 30, 2022 16:22
@aaime
Copy link
Member Author

aaime commented May 30, 2022

And now a new error:

sphinx:
     [echo] Running sphinx-build -D release=28-SNAPSHOT -q -W --keep-going -j auto -b html -d "/home/runner/work/geotools/geotools/docs/target/developer/doctrees" . "/home/runner/work/geotools/geotools/docs/target/developer/html"
     [exec] 
     [exec] Exception occurred:
     [exec]   File "/opt/hostedtoolcache/Python/3.10.4/x64/lib/python3.10/site-packages/docutils/nodes.py", line 654, in __getitem__
     [exec]     return self.children[key]
     [exec] IndexError: list index out of range
     [exec] The full traceback has been saved in /tmp/sphinx-err-74d5y0gp.log, if you want to report the issue to the developers.
     [exec] Please also report this if it was a user error, so that a better error message can be provided next time.
     [exec] A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

I cannot reproduce locally though, using the latest Sphinx (I could reproduce the extlinks warning).
The same changes in GeoServer appear to be working fine:
geoserver/geoserver#5908

@aaime
Copy link
Member Author

aaime commented May 31, 2022

We're not the only ones experiencing this last error.

Going to try to peg Sphinx to an earlier version, using Sphinx 5.0 the day it's released it's probably not a good idea :-D.

@aaime aaime merged commit e5d6157 into geotools:main May 31, 2022
@aaime aaime deleted the sphinx_extlinks_fail branch May 31, 2022 08:36
aaime added a commit to aaime/geotools that referenced this pull request May 31, 2022
…x build) (geotools#3910)

* [GEOT-7154] Sphinx build failure with extlinks (new warnings in Sphinx build)

* Align python setup with GeoServer workflows

* Trying to peg Sphinx to 4.5
aaime added a commit to aaime/geotools that referenced this pull request May 31, 2022
…x build) (geotools#3910)

* [GEOT-7154] Sphinx build failure with extlinks (new warnings in Sphinx build)

* Align python setup with GeoServer workflows

* Trying to peg Sphinx to 4.5
aaime added a commit that referenced this pull request May 31, 2022
…x build) (#3910)

* [GEOT-7154] Sphinx build failure with extlinks (new warnings in Sphinx build)

* Align python setup with GeoServer workflows

* Trying to peg Sphinx to 4.5
aaime added a commit that referenced this pull request May 31, 2022
…x build) (#3910)

* [GEOT-7154] Sphinx build failure with extlinks (new warnings in Sphinx build)

* Align python setup with GeoServer workflows

* Trying to peg Sphinx to 4.5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant