Cleanup documentation #1052
Merged
Cleanup documentation #1052
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
Member
jdknight
commented
Oct 13, 2024
jdknight
commented
- rework page breaks for pdf
- add explicit verbatim spacing for pdf
- minimize spacing between admonitions
- generic grammar, formatting, etc.
- replace various literal/replace tricks with lref roles
Configures automatic page breaks for each section. This removes the need for a series of explicit `\newpage` hints in the documentation. This commit does add some new `\newpage` hint in some areas where it subjectively presents content in a nicer fashion. Signed-off-by: James Knight <git@jdknight.me>
Define 0.75em spacing in code/literal blocks to subjectively improve the presentation of the content in these blocks. Signed-off-by: James Knight <git@jdknight.me>
The margins around admonitions are big; reducing their size. Signed-off-by: James Knight <git@jdknight.me>
Signed-off-by: James Knight <git@jdknight.me>
This documentation configuration added an `lref` to help create literal-themed references between individual documents. The role can also be used for internal links on a page over using literal/replacement trick to literal-style references; switching. Signed-off-by: James Knight <git@jdknight.me>
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.