Skip to content

Conversation

@maxrjones
Copy link
Member

Description of proposed changes

This PR updates sphinx_rtd_theme. Fixes #1149.

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@maxrjones maxrjones added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Mar 30, 2021
@seisman
Copy link
Member

seisman commented Mar 30, 2021

See #629 for why we pin sphinx_rtd_theme to 0.4.3

@maxrjones
Copy link
Member Author

maxrjones commented Mar 30, 2021

See #629 for why we pin sphinx_rtd_theme to 0.4.3

Yes, there is a lot of whitespace in the parameters section. In my opinion, the search functionality is more important than limiting the whitespace. We can adjust style.css for the latest theme version as necessary.

@seisman seisman added this to the 0.4.0 milestone Mar 30, 2021
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Mar 30, 2021
@maxrjones
Copy link
Member Author

I think it will be possible to use styles.css to format the parameters section as a block rather than a grid to eliminate the extra whitespace, similar to the older versions of sphinx_rtd_theme. As you mentioned in #629, it will also be necessary to check that the other configurations in style.css are compatible with 0.5.1. Should I do that now in this PR, or better to wait to do it after?

@seisman
Copy link
Member

seisman commented Mar 30, 2021

Should I do that now in this PR, or better to wait to do it after?

Better in a separate PR.

@seisman
Copy link
Member

seisman commented Mar 30, 2021

Should I do that now in this PR, or better to wait to do it after?

Better in a separate PR.

You can also create a new branch from this PR, so you can work on the new style with the latest theme.

Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

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

Good work! I think everything needed is done here.

@maxrjones maxrjones self-assigned this Mar 30, 2021
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Looks good to me. One question though, do we need to backport this somehow to the gh-pages branch?

@core-man
Copy link
Member

Great~ I thought it was a problem with my internet that I cannot use search.

@maxrjones
Copy link
Member Author

Looks good to me. One question though, do we need to backport this somehow to the gh-pages branch?

I'm not really sure. If it can be done after merging, I think it would be best to figure out if any custom CSS changes are needed before backporting. @seisman do you have any insights here?

@seisman
Copy link
Member

seisman commented Mar 31, 2021

If it can be done after merging, I think it would be best to figure out if any custom CSS changes are needed before backporting

Yes, it sounds good to me.

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 31, 2021
@maxrjones maxrjones merged commit 0e64122 into master Mar 31, 2021
@maxrjones maxrjones deleted the rtd-theme-version branch March 31, 2021 13:47
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bump sphinx rtd theme to fix search indexing

6 participants