Minor RTD visual enhancements #420
Merged
Conversation
This file contains 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
Use napoleon fork hosted in the project umbrella github organization "secure-systems-lab", to display our custom "Side Effects" docstring section (kudos to @SolidifiedRay for patching napoleon). Also ssee in-toto#401 for discussed alternatives and attempts to upstream this or a more flexible solution. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Horizontal looks nicer than stacked and white looks nicer than red/blue for the currently used RTD theme. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
We currently use a fork of the stand-alone Napoleon sphinx extension that fixes in-toto#401. However, we should instead use the more up-to-date Napoleon extension built into sphinx, and maybe try to upstream our patch there. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
adityasaky
approved these changes
Dec 21, 2020
Thanks for the review, @adityasaky! Let's merge here and keep #401 open. |
3 tasks
Merged
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.
Fixes #388 and tempfixes #401
Description of the changes being introduced by the pull request:
See https://in-toto-lukpueh.readthedocs.io/en/latest/api.html for a demo.
Please verify and check that the pull request fulfills the following
requirements: