Collapse docstrings in documentation to allow for easier navigation#4758
Merged
Collapse docstrings in documentation to allow for easier navigation#4758
Conversation
Contributor
|
we will do this, by unanimous decision. @thofma will finish it. |
Collaborator
Author
|
Added it to all doc pages. Should be good to go if the documentation still builds. |
Member
|
This doesn't touch the |
Member
It should do it for all |
Member
|
See also JuliaDocs/Documenter.jl#2512 |
Collaborator
Author
|
I updated all the files. (Would of course be great if there were some builtin functionality to do this, but I suggest we don't wait for it.) |
fingolfin
approved these changes
Apr 24, 2025
fieker
pushed a commit
that referenced
this pull request
May 16, 2025
lgoettgens
changed the title
lgoettgens
added
the
release notes: use title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
I noticed that with collapsed docstrings (by default) the pages look much clearer if single docstrings are long (because of examples). There is a button to do it at the top right corner, but l add it here directly, so that we can compare it easier.
Collapsed by default: https://docs.oscar-system.org/previews/PR4758/CommutativeAlgebra/ideals/
Current verion: https://docs.oscar-system.org/dev/CommutativeAlgebra/ideals/