feat: read docstrings from doc-gen4#776
Open
david-christiansen wants to merge 21 commits intomainfrom
Open
Conversation
This PR implements an alternative path to docstring rendering that reads the necessary data from a doc-gen4 SQLite database, to work around the fact that docstring info is no longer available in the environment with the module system and to allow a global view of the project for things like instance lists.
david-christiansen
force-pushed
the
docgen-dump-docstrings
branch
from
f40b8cf to
a2ea28e
Compare
david-christiansen
changed the title
Contributor
|
Preview for this PR is ready! 🎉 |
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
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 the ability to read docstrings from doc-gen4's SQLite database instead of the environment.
This has the following benefits:
I've verified that the reference manual builds against this branch with only trivial changes (four modified files, two of which are the Lakefile and Lake manifest). The internal Verso user manual now uses the module system, demonstrating that the approach actually works.
As part of making the Verso user's guide use the module system, most of Verso itself was also migrated to the module system.