DM-28598: Fix pipetask command-line utility doc generation. #115
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
timj
approved these changes
Feb 12, 2021
jonathansick
requested changes
Feb 16, 2021
There was a problem hiding this comment.
Yep, these changes are fine.
One bit of feedback is that the practice of putting the command-line reference directly on the module's homepage isn't consistent with our documentation design. Instead, you want each command-line reference on its own page, and link to those command-line references using a toctree in the index.rst file using the "Command line scripts" heading.
The rST content was severely bitrotted. I'm not sure what was going on with the conf.py, but sphinx couldn't find its click extensions without this change, which is just mindless cargo-culting from daf_butler.
TallJimbo
force-pushed
the
tickets/DM-28598
branch
from
d022b5d
to
fba72f8
Compare
|
Merging before the |
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.
The rST content was severely bitrotted. I'm not sure what was going on with the conf.py, but sphinx couldn't find its click extensions
without this change, which is just mindless cargo-culting from daf_butler.