Skip to content

documented plugin documentation on documenting #1219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

documented plugin documentation on documenting #1219

wants to merge 1 commit into from

Conversation

bcoca
Copy link
Member

@bcoca bcoca commented Mar 19, 2024

Cause it is similar but NOT the same as modules

oraNod
oraNod approved these changes Mar 19, 2024
View reviewed changes
Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @bcoca LGTM

@felixfontein
Copy link
Collaborator

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
Akasurde reviewed Mar 20, 2024
View reviewed changes
@ansible-documentation-bot ansible-documentation-bot bot added the sc_approval This PR requires approval from the Ansible Community Steering Committee label Mar 20, 2024
@bcoca
Copy link
Member Author

bcoca commented Mar 20, 2024

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.

@bcoca
Copy link
Member Author

bcoca commented Mar 21, 2024 •
edited
Loading

felixfontein I agree, i remember discussing a 'shared snippet' infrastructure, but I don't know if or how it got implemented.

@bcoca bcoca marked this pull request as ready for review March 21, 2024 23:06
@bcoca bcoca requested a review from a team as a code owner March 21, 2024 23:06
@bcoca
Copy link
Member Author

bcoca commented Mar 21, 2024

duh, sphinx already supports:

.. include:: ../shared/folder/filename.rst

@bcoca @Akasurde
documented plugin documentation on documenting
1a62371 
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 <[email protected]>
@bcoca bcoca force-pushed the plugin_doc_details branch from ab01908 to 1a62371 Compare March 21, 2024 23:35
@oraNod
Copy link
Contributor

oraNod commented Sep 12, 2024

Hi @bcoca We've made some changes to the underlying readthedocs project for this repository. I'm going to close and re-open this issue to kick off a new PR preview build.

You might notice there will be two checks for readthedocs. One for docs/readthedocs.org:stage-ansible-core and another for docs/readthedocs.org:ansible-core.

The stage-ansible-core check is for the old project and will result in a 404. Please ignore that and use the ansible-core check only.

Thank you for your patience and understanding.

@oraNod oraNod closed this Sep 12, 2024
@oraNod oraNod reopened this Sep 12, 2024
@oraNod oraNod self-requested a review July 15, 2025 15:36
@samccann samccann mentioned this pull request Jul 15, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Akasurde Akasurde Akasurde left review comments

@oraNod oraNod Awaiting requested review from oraNod

Assignees
No one assigned
Labels
sc_approval This PR requires approval from the Ansible Community Steering Committee
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bcoca @felixfontein @oraNod @Akasurde