Update sphinx-apidoc command to exclude benchmarking docs #2021
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
kclowes
force-pushed
the
sphinx-exclude-benchmark
branch
from
cd3d66e to
fdb47ff
Compare
wolovim
approved these changes
Jun 10, 2021
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.
What was wrong?
Every time
make build-docswas run, a docs/web3.tools.benchmark.rst file was auto generated by sphinx-apidoc.How was it fixed?
Added
web3/toolsto the list of exclude patterns for apidoc. Also removed theweb3/utilspattern since we no longer have autilsfile.Todo:
Cute Animal Picture