Fix param:type rendering in v3 docs #4852
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelosthege
approved these changes
Jul 13, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank your for opening a PR!
Depending on what your PR does, here are a few things you might want to address in the description:
what are the (breaking) changes that this PR makes?
Fixes Consistently use param: type in docstrings #4284 for v3 docs.
Preview the docs built on my fork with respect to docs.pymc.io
important background, or details about the implementation
Added custom css as per Fix #5959: classifier delimiter is not shown sphinx-doc/sphinx#5976.
We could have also used the entire sphinx basic.css file, but I just used a small css snippet which is enough to solve the issue. Adding the entire basic.css file changes a lot how v3 docs look.
right before it's ready to merge, mention the PR in the RELEASE-NOTES.md