feat: sublibrary for adding supplement pages and sections #340
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
This PR adds a library `SubDocGen` that defines a pair of environment extensions, and helper functions for adding definitions to these extensions. In a follow-up PR, these extensions will be used to render supplement pages, in addition to API documentation. For example, Mathlib can generate an overview of all library notes, Stacks tags and `norm_num` extensions, without having to program support specifically into DocGen for each of them. The environment extensions need to be imported by projects in order to add to the supplement, so I define it as its own library rather than a piece of DocGen itself. The main open question I have right now is Verso support. The entries of the environment extension are intentionally dependent on the type of (doc)string they contain, so switching them out all at once should be easy. I wonder if it would be better to instead have two extensions: one storing Markdown strings and one for storing Verso strings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds a library
SubDocGenthat defines a pair of environment extensions, and helper functions for adding definitions to these extensions. In a follow-up PR (see my supplements branch for the work in progress), these extensions will be used to render supplement pages, in addition to API documentation. For example, Mathlib can generate an overview of all library notes, Stacks tags andnorm_numextensions, without having to program support specifically into DocGen for each of them.The environment extensions need to be imported by projects in order to add to the supplement, so I define it as its own library rather than a piece of DocGen itself.
The main open question I have right now is Verso support. The entries of the environment extension are intentionally dependent on the type of (doc)string they contain, so switching them out all at once should be easy. I wonder if it would be better to instead have two extensions: one storing Markdown strings and one for storing Verso strings?