Improve readability of sub-modules on the Formulary documentation page #867
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
…s under "Examples" in the sidebar
…ble table of sub-modules
rocco8773
added
docs
Codecov Report
@@ Coverage Diff @@
## master #867 +/- ##
=======================================
Coverage 96.07% 96.07%
=======================================
Files 59 59
Lines 5225 5225
=======================================
Hits 5020 5020
Misses 205 205 Continue to review full report at Codecov.
|
StanczakDominik
approved these changes
Jul 14, 2020
StanczakDominik
approved these changes
Jul 14, 2020
3 tasks
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.
I felt the current documentation page for the formulary module was difficult to ready. The sub-module list is rather busy and not alphabetized (see Current Layout below), making it hard to look at and find what you want. So, in the New Layout I made the following changes...
toctreenames so the sidebar just shows the label for the sub-module and not the full module syntax.toctreedirective and created a table with the simplified module name and the module syntax. (I think this greatly improve the readability)nbgalleryinto an Examples sub-section, so the galleries appear in an Examples drop-down in the sidebar.Current Layout
New Layout