Skip to content

Conversation

@seisman
Copy link
Member

@seisman seisman commented Sep 22, 2020

Description of proposed changes

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.

@weiji14
Copy link
Member

weiji14 commented Sep 23, 2020

So sphinx and sphinx_rtd_theme was pinned at #383, and the main change I notice is a condensed API documentation?

Old (current):

image

New (This PR):

image

Doesn't look too bad 😄

@seisman
Copy link
Member Author

seisman commented Sep 23, 2020

It wastes too many spaces on the left side.

image

@weiji14
Copy link
Member

weiji14 commented Sep 23, 2020

Yeah it does. I do like how the vertical whitespace is compressed (for the Aliases especially). Maybe we can configure it somehow (looking at https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html), or pin to a different version?

@seisman
Copy link
Member Author

seisman commented Sep 23, 2020

Note that we also have a custom style.css which may or may not be compatible with new sphinx and sphinx_rtd_theme.

@weiji14 weiji14 added the maintenance Boring but important stuff for the core devs label Oct 2, 2020
@seisman
Copy link
Member Author

seisman commented Dec 15, 2020

It seems unpinning the sphinx version doesn't change the appearance of the API documentation.

Can we merge the PR?

@seisman seisman marked this pull request as ready for review December 15, 2020 07:38
@seisman seisman requested a review from a team December 15, 2020 07:38
@seisman seisman added this to the 0.3.0 milestone Dec 15, 2020
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.

Interesting, good to unpin it then!

@seisman seisman changed the title Unpin sphinx and sphinx_rtd_theme version Unpin the Sphinx version Dec 15, 2020
@seisman seisman merged commit 9aa3d36 into master Dec 15, 2020
@seisman seisman deleted the unpin-sphinx branch December 15, 2020 08:12
@weiji14 weiji14 added the skip-changelog Skip adding Pull Request to changelog label Feb 6, 2021
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.

3 participants