documented plugin documentation on documenting #1219
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
oraNod
approved these changes
Mar 19, 2024
|
This is replicating quite some content from the other document, like details of semantic markup, which we should clean up and move to a single place after merging this (or before, idk). |
Akasurde
reviewed
Mar 20, 2024
docs/docsite/rst/dev_guide/developing_collections_documenting.rst
Outdated
Show resolved
Hide resolved
ansible-documentation-bot
bot
added
the
sc_approval
|
not sure which toctree to add this to so it passes tests, also weird since i don't see module_documentation in any toctree either. |
|
felixfontein I agree, i remember discussing a 'shared snippet' infrastructure, but I don't know if or how it got implemented. |
|
duh, sphinx already supports: |
Apply suggestions from code review Move some comment to 'common snippet' to be included in both plugin and module pages Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
bcoca
force-pushed
the
plugin_doc_details
branch
from
ab01908
to
1a62371
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.
Cause it is similar but NOT the same as modules