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

Fix parameters section with sphinx_rtd_theme 5.x.x #1197

Merged
merged 3 commits into from
Apr 10, 2021
Merged

Fix parameters section with sphinx_rtd_theme 5.x.x #1197

merged 3 commits into from
Apr 10, 2021

Conversation

maxrjones
Copy link
Member

Description of proposed changes

This PR updates style.css for the newer version of sphinx_rtd_theme. So far, the parameters section is updated to not waste so much space on the left side. It would be helpful if people point out any other issues that need addressing.

Acknowledgement to this helpful post: readthedocs/sphinx_rtd_theme#766 (comment)

Fixes #1151

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 Apr 9, 2021
@seisman seisman added this to the 0.4.0 milestone Apr 9, 2021
seisman
seisman approved these changes Apr 9, 2021
View reviewed changes
Copy link
Member

@seisman seisman 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.

weiji14
weiji14 approved these changes Apr 9, 2021
View reviewed changes
Copy link
Member

@weiji14 weiji14 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Much better, thanks @meghanrjones! Feel free to merge in directly.

@seisman seisman merged commit 4fc657c into master Apr 10, 2021
@seisman seisman deleted the sphinx-custom-css branch April 10, 2021 02:42
@maxrjones maxrjones mentioned this pull request Apr 10, 2021
Closed
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Fix parameters section with sphinx_rtd_theme 5.x.x (GenericMappingToo…
7c4bb30 
…ls#1197)

* Update custom css for parameters section
* Add grey box around parameters in docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weiji14 weiji14 weiji14 approved these changes

@seisman seisman seisman approved these changes

Assignees
No one assigned
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Milestone
0.4.0
Development

Successfully merging this pull request may close these issues.

Update CSS for sphinx_rtd_theme 0.5.1
3 participants
@maxrjones @seisman @weiji14