Skip to content
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.

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

Also check .txt files with rstcheck #2384

Merged
merged 2 commits into from
Feb 12, 2025

Conversation

felixfontein
Copy link
Collaborator

Some (included) RST files have the .txt ending:

docs/docsite/rst/dev_guide/shared_snippets/licensing.txt
docs/docsite/rst/getting_started/ansible_output/first_playbook_output.txt
docs/docsite/rst/getting_started/ansible_output/ping_inventory_output.txt
docs/docsite/rst/getting_started/ansible_output/ping_output.txt
docs/docsite/rst/inventory_guide/shared_snippets/SSH_password_prompt.txt
docs/docsite/rst/network/user_guide/shared_snippets/SSH_warning.txt
docs/docsite/rst/playbook_guide/shared_snippets/role_directory.txt
docs/docsite/rst/playbook_guide/shared_snippets/with2loop.txt
docs/docsite/rst/shared_snippets/basic_concepts.txt
docs/docsite/rst/shared_snippets/download_tarball_collections.txt
docs/docsite/rst/shared_snippets/galaxy_server_list.txt
docs/docsite/rst/shared_snippets/installing_collections_git_repo.txt
docs/docsite/rst/shared_snippets/installing_multiple_collections.txt
docs/docsite/rst/shared_snippets/installing_older_collection.txt
docs/docsite/rst/tips_tricks/shared_snippets/role_directory.txt

Make sure these are also checked.

@felixfontein
Copy link
Collaborator Author

Hmm, from the errors it seems that not all .txt files are RST...

We either need to explicitly exclude these, or find another criterium to figure out which .txt files are RST and which are not.

@samccann
Copy link
Contributor

samccann commented Feb 5, 2025

So the stuff in 'snippets' are rst usually (tho maybe not always). In general, we should probably just get rid of using snippets. The original idea was to use the same 'snippet' of documentation in more than one location in the docs. Most of them could probably be removed and put the docs directly in the file that includes them. Then the other include could be a link to this new location instead of repeating the text.

@felixfontein
Copy link
Collaborator Author

Until we get rid of them, should we merge this as-is so that the snippets that actually contain RST are checked as well?

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.

Thank you @felixfontein

@felixfontein felixfontein merged commit f22daf4 into ansible:devel Feb 12, 2025
11 checks passed
@felixfontein felixfontein deleted the rst-extensions branch February 12, 2025 17:54
@felixfontein
Copy link
Collaborator Author

@samccann @oraNod thanks for reviewing!

ketankelkar pushed a commit to ketankelkar/ansible-documentation that referenced this pull request Feb 18, 2025
* Also check .txt files with rstcheck.

* Ignore .txt files in docs/docsite/rst/getting_started/ansible_output.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants