Skip to content

Update accepted docutils versions#205

Merged
grst merged 6 commits intomainfrom
fix-citations
Jun 6, 2023
Merged

Update accepted docutils versions#205
grst merged 6 commits intomainfrom
fix-citations

Conversation

@flying-sheep
Copy link
Copy Markdown
Member

@flying-sheep flying-sheep commented Jun 5, 2023 •
edited
Loading

Fixes #190

Docutils 0.20 has the patch we need, and Sphinx 7.0.1 is necessary for docutils 0.20, sphinx-book-theme only accepts sphinx <7

Therefore we can specify docutils>=0.8, !=0.18.*, !=0.19.*, which will give us docutils 0.17 until sphinx-book-theme supports sphinx 7.

@scverse-bot scverse-bot mentioned this pull request Jun 5, 2023
Closed
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 5, 2023

A PR has been generated to the instance repo:
scverse/cookiecutter-scverse-instance#71

You can check out the PR to preview your changes
in an instance of the cookiecutter template. The PR will be kept in sync with
this PR automatically.

@flying-sheep flying-sheep changed the title Update minimum docutils version Update accepted docutils versions Jun 6, 2023
@flying-sheep flying-sheep requested a review from grst June 6, 2023 13:41
@grst
Copy link
Copy Markdown
Collaborator

grst commented Jun 6, 2023

which will give us docutils 0.17 until sphinx-book-theme supports sphinx 7

what's the benefit of 0.17 over .18 and .19?

@flying-sheep
Copy link
Copy Markdown
Member Author

flying-sheep commented Jun 6, 2023

It creates valid HTML and doesn’t mess up our layout horribly. See #190

grst
grst approved these changes Jun 6, 2023
View reviewed changes
Copy link
Copy Markdown
Collaborator

@grst grst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see... so the regression was introduced in 0.18 and will be fixed in 0.20...

@grst grst merged commit 59d694b into main Jun 6, 2023
@grst grst deleted the fix-citations branch June 6, 2023 14:11
@flying-sheep
Copy link
Copy Markdown
Member Author

flying-sheep commented Jun 6, 2023

looks like it yeah!

@flying-sheep
Copy link
Copy Markdown
Member Author

flying-sheep commented Jun 6, 2023

@grst do you want to do the release with this? I hope the update code finally works!

@grst
Copy link
Copy Markdown
Collaborator

grst commented Jun 6, 2023

So you mean cherry-picking this one as well into the 0.2.x branch?

@flying-sheep
Copy link
Copy Markdown
Member Author

flying-sheep commented Jun 6, 2023

yeah, I’ve been doing a lot of releases because there was no good way to test

@martinkim0 martinkim0 mentioned this pull request Jul 13, 2023
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@grst grst grst approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

"references" page in documentation not rendered correctly

2 participants

@flying-sheep @grst