build: Don't try to read the database when building docs. #37919
+10
−2
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
Sphinx tries to explore all the defined objects when trying to generate docs from the code. When it tries to introspect the QuerySet object, it results in that object trying to query the database which we don't really want to setup for a docs build as it's not relevant and fairly expensive to do. To circumvent this issue, we add a new filter to the docs build that essentially skips further introspection of QuerySet objects.
feanil
force-pushed
the
feanil/fix_docs_build
branch
from
ab9009e to
53d5e7b
Compare
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.
Sphinx tries to explore all the defined objects when trying to generate
docs from the code. When it tries to introspect the QuerySet object, it
results in that object trying to query the database which we don't
really want to setup for a docs build as it's not relevant and fairly
expensive to do. To circumvent this issue, we add a new filter to the
docs build that essentially skips further introspection of QuerySet
objects.