Sphinx config fix #458
Merged
Sphinx config fix #458
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
We don't want those directories commited to the git repository. Python virtual environments are often created in a .venv/ directory, thus ignoring all .venv/ directories. The docs/_build directory is automatically created by Sphinx when the documentation is generated. We don't want the generated documentation to be commited to the repository.
This is required because if someone stores the virtualenv in a .venv directory (common practice) under the docs/ path, then Sphinx will try to pickup all files under the virtualenv. This leads to a lot of errors, performance impacts and side effects.
There are currently no additional static files for Sphinx in place, but there's a _static directory configured in the Sphinx docs. When creating the Sphinx docs without an `mkdocs _static` command before, this leads to an error. Thus removing the _static path until we need it again.
|
Looks good, thanks for improving the documentation! 🥇 |
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.
Fixed some minor things in the config. Please have a look at the changes & commit messages for more infos.