Update docs on working on docs #74201
Merged
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
Without the '.', the command would fail and not remove symilnks.
ansibot
added
affects_2.12
core_review
samdoran
removed
the
needs_triage
ansibot
added
the
stale_ci
Rather than documenting that the end user needs to run two make targets to test changes to a file, modify the Makefile so that htmlsingle invokes the other make target. Change the dependencies for the *_structure targets. They don't depend on generating the module and plugin docs so move the dependency to a higher level target instead. This way, the htmlsingle target doesn't need to run those. Add make to the list of dependent packages needed to build the docs.
ansibot
removed
the
stale_ci
samccann
approved these changes
Apr 21, 2021
|
Tested locally and making the single HTML seems to work again (woot!) Making w/o modules (MODULES=none) doesn't seem to work, but we can cover that in a separate discussion/PR. |
webknjaz
reviewed
Apr 21, 2021
| - sphinx-notfound-page | ||
| - straight.plugin | ||
| - ``gcc`` | ||
| - ``jinja2`` |
There was a problem hiding this comment.
Wouldn't it be easier to point to requirements/constraints files that already have this info?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
SUMMARY
Fix a bug in the
make cleantarget that would not cleanup symlinks.Add documentation describing how to setup the configuration before trying to generate docs. This is a new requirement since the documentation was split up.
ISSUE TYPE
COMPONENT NAME
docs/docsite/rst/community/documentation_contributions.rst