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.

Sign up for GitHub

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

Jump to bottom

RTD build failing #2023

Closed
lmoureaux opened this issue Aug 22, 2023 · 4 comments · Fixed by #2024
Closed

RTD build failing #2023

lmoureaux opened this issue Aug 22, 2023 · 4 comments · Fixed by #2024
Assignees
@lmoureaux @jwrober
Labels
bug Something isn't working documentation Improvements or additions to documentation important This issue should be fixed asap

Comments

@lmoureaux
Copy link
Contributor

Describe the bug

RTD failed in #2022 with:

Manuals/Program/freeciv21-server.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.

I think it doesn't like the double space after the dots:

..  SPDX-License-Identifier: GPL-3.0-or-later
..  SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>

To Reproduce
Steps to reproduce the behavior:

  1. Trigger an RTD build
  2. Watch it fail
@lmoureaux lmoureaux added bug Something isn't working documentation Improvements or additions to documentation important This issue should be fixed asap labels Aug 22, 2023
@lmoureaux
Copy link
Contributor Author

Temporarily disabled the requirement that RTD passes to merge PRs

@jwrober
Copy link
Collaborator

jwrober commented Aug 22, 2023

Something has changed at RTD then. Since that has been in there for some time and was not failing before.

@jwrober jwrober self-assigned this Aug 22, 2023
@daavko
Copy link
Collaborator

daavko commented Aug 23, 2023

Seems like it got broken by RTD updating Sphinx to 7.2.2 - last successful build seems to be with Sphinx 6.2.1 by looking at the raw logs. A quick workaround might be to pin Sphinx to v6 if that's possible.

Poking around a bit more, it seems like it fails due to the sphinx-last-updated-by-git plugin throwing an assertion error for some reason. Looking at the code, the only time that assertion is ran is for a source-read event from Sphinx which seems to have been touched recently in sphinx-doc/sphinx#11510) which fixed sphinx-doc/sphinx#10678. I'd assume the plugin simply doesn't expect the new behavior for the event, and the fact that it may now return None for one of the parameters in some cases. That would make it a similar bug to this one: sphinx-gallery/sphinx-gallery#1175, possibly with some extra steps.

That's about as far as my momentary interest got me with this. An issue for the plugin author would probably be in order. Or use a different plugin for the "last updated" thing in the footer.

Wrt the warning about explicit markup not ending with a blank line, that isn't a new thing. It occurs even in successful builds. Just take a look at the raw logs. There's plenty more warnings other than for the explicit markup.

@johannesloibl johannesloibl mentioned this issue Aug 24, 2023
Merged
@lmoureaux lmoureaux mentioned this issue Aug 25, 2023
Closed
@lmoureaux lmoureaux self-assigned this Aug 25, 2023
lmoureaux added a commit to lmoureaux/freeciv21 that referenced this issue Aug 25, 2023
@lmoureaux
Docs: pin sphinx to <7.2
1ca95c6 
This is a short-term solution for longturn#2023. In the long run, upstream
issues should be fixed:
* sphinx-doc/sphinx#11643
* mgeier/sphinx-last-updated-by-git#57

Closes longturn#2023.
@lmoureaux lmoureaux mentioned this issue Aug 25, 2023
Merged
jwrober pushed a commit that referenced this issue Aug 26, 2023
@lmoureaux @jwrober
Docs: pin sphinx to <7.2
f105cd4 
This is a short-term solution for #2023. In the long run, upstream
issues should be fixed:
* sphinx-doc/sphinx#11643
* mgeier/sphinx-last-updated-by-git#57

Closes #2023.
@lmoureaux
Copy link
Contributor Author

Upstream bugs have been fixed. We can use sphinx_last_updated_by_git >= 0.3.6 with sphinx > 7.2.5 once the latter has been released.

lmoureaux added a commit that referenced this issue Nov 23, 2023
@lmoureaux
Docs: pin sphinx to <7.2
6be97a4 
This is a short-term solution for #2023. In the long run, upstream
issues should be fixed:
* sphinx-doc/sphinx#11643
* mgeier/sphinx-last-updated-by-git#57

Closes #2023.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lmoureaux lmoureaux

@jwrober jwrober

Labels
bug Something isn't working documentation Improvements or additions to documentation important This issue should be fixed asap
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs: pin sphinx to <7.2 lmoureaux/freeciv21
3 participants
@daavko @lmoureaux @jwrober