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

Specify minimum version of sphinx_rtd_theme to allow most recent release of docutils #1275

Merged
merged 9 commits into from
Sep 29, 2021
Merged

Specify minimum version of sphinx_rtd_theme to allow most recent release of docutils #1275

merged 9 commits into from
Sep 29, 2021

Conversation

namurphy
Copy link
Member

Earlier this year we had some difficulties with docutils 0.17 and higher, which appeared to be incompatibilities with sphinx_rtd_theme. I checked the changelog for sphinx_rtd_theme, and the recently released version 1.0.0 is apparently now compatible with more recent versions of docutils. This PR updates the requirements for both docutils and sphinx_rtd_theme to test that this fix actually does work.

@namurphy namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label Sep 22, 2021
@github-actions github-actions bot removed the docs PlasmaPy Docs at http://docs.plasmapy.org label Sep 22, 2021
@codecov
Copy link

codecov bot commented Sep 22, 2021 •
edited
Loading

Codecov Report

❗ No coverage uploaded for pull request base (main@bcfa2c2). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1275   +/-   ##
=======================================
  Coverage        ?   97.07%           
=======================================
  Files           ?       73           
  Lines           ?     7106           
  Branches        ?        0           
=======================================
  Hits            ?     6898           
  Misses          ?      208           
  Partials        ?        0

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bcfa2c2...5f8d033. Read the comment docs.

@namurphy
Copy link
Member Author

Fortunately, this seems to be working! I'm not sure about which minimum version of docutils should be allowed, so I'll need to:

  • Determine what the minimum version of docutils should be

@namurphy
Require docutils >= 0.16
2692644
@namurphy
Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into docutils_sph…
c373d71 
…inx_rtd_theme
@namurphy
Remove version requirement for docutils
5d8ffa5 
There is a minimum version of docutils required by Sphinx, so I don't
think we need to specify one ourselves.
@namurphy namurphy changed the title Update requirements for docutils and sphinx_rtd_theme Specify minimum version of sphinx_rtd_theme to allow most recent release of docutils Sep 27, 2021
@namurphy namurphy marked this pull request as ready for review September 27, 2021 20:37
@namurphy namurphy added the status: ready for review PRs that are ready for code review label Sep 27, 2021
@StanczakDominik
Copy link
Member

There is a minimum version of docutils required by Sphinx, so I don't think we need to specify one ourselves.

I would agree if we were only depending on functionality provided by Sphinx itself; but plasmapy-sphinx makes me less sure of that!

@namurphy namurphy requested a review from rocco8773 September 29, 2021 03:37
@namurphy
Copy link
Member Author

The two problems with docutils ≥ 0.17 that I knew of were...

Both of those seem to no longer be problems in the docs preview with sphinx_rtd_theme ≥ 1.0.0 (looking at doc previews on Firefox from Ubuntu). @rocco8773 — is there any reason why we'd need to set a minimum version for docutils?

rocco8773
rocco8773 reviewed Sep 29, 2021
View reviewed changes
changelog/1275.doc.rst Outdated Show resolved Hide resolved
@namurphy
Copy link
Member Author

namurphy commented Sep 29, 2021 •
edited
Loading

  • Check that :issue: and :pr: work in changelog entry

@namurphy namurphy enabled auto-merge (squash) September 29, 2021 21:47
@namurphy namurphy merged commit d71d84b into PlasmaPy:main Sep 29, 2021
Tlord18 pushed a commit to Tlord18/PlasmaPy that referenced this pull request Oct 6, 2021
@namurphy @rocco8773 @Timelord18
Specify minimum version of sphinx_rtd_theme to allow most recent rele…
514f60e 
…ase of docutils (PlasmaPy#1275)

* Update requirements for docutils and sphinx_rtd_theme

* Add changelog entry

* Require docutils >= 0.16

* Remove version requirement for docutils

There is a minimum version of docutils required by Sphinx, so I don't
think we need to specify one ourselves.

* Update changelog/1275.doc.rst

Co-authored-by: Erik Everson <[email protected]>

* Update changelog entry

* Add manual links for PR and issue

Co-authored-by: Erik Everson <[email protected]>
Tlord18 pushed a commit to Tlord18/PlasmaPy that referenced this pull request Oct 6, 2021
@namurphy @rocco8773 @Timelord18
Specify minimum version of sphinx_rtd_theme to allow most recent rele…
6afb952 
…ase of docutils (PlasmaPy#1275)

* Update requirements for docutils and sphinx_rtd_theme

* Add changelog entry

* Require docutils >= 0.16

* Remove version requirement for docutils

There is a minimum version of docutils required by Sphinx, so I don't
think we need to specify one ourselves.

* Update changelog/1275.doc.rst

Co-authored-by: Erik Everson <[email protected]>

* Update changelog entry

* Add manual links for PR and issue

Co-authored-by: Erik Everson <[email protected]>
@namurphy namurphy deleted the docutils_sphinx_rtd_theme branch March 16, 2022 15:47
@namurphy namurphy removed the status: ready for review PRs that are ready for code review label Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rocco8773 rocco8773 rocco8773 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.
3 participants
@namurphy @StanczakDominik @rocco8773