Adjust URLs (#428)

* Adjust URLs.

* Add changelog fragment.

Author: felixfontein

README.md

@@ -5,7 +5,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
 # antsibull-docs -- Ansible Documentation Build Scripts
-[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://ansible.readthedocs.io/projects/antsibull-docs/)
+[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://docs.ansible.com/projects/antsibull-docs/)
 [![Discuss on Matrix at #antsibull:ansible.com](https://img.shields.io/matrix/antsibull:ansible.com.svg?server_fqdn=ansible-accounts.ems.host&label=Discuss%20on%20Matrix%20at%20%23antsibull:ansible.com&logo=matrix)](https://matrix.to/#/#antsibull:ansible.com)
 [![Discuss on Matrix at #docs:ansible.com](https://img.shields.io/matrix/docs:ansible.com.svg?server_fqdn=ansible-accounts.ems.host&label=Discuss%20on%20Matrix%20at%20%23docs:ansible.com&logo=matrix)](https://matrix.to/#/#docs:ansible.com)
 [![Nox badge](https://github.com/ansible-community/antsibull-docs/actions/workflows/nox.yml/badge.svg)](https://github.com/ansible-community/antsibull-docs/actions/workflows/nox.yml)
@@ -14,15 +14,15 @@ SPDX-License-Identifier: GPL-3.0-or-later
 [![Codecov badge](https://img.shields.io/codecov/c/github/ansible-community/antsibull-docs)](https://codecov.io/gh/ansible-community/antsibull-docs)
 [![REUSE status](https://api.reuse.software/badge/github.com/ansible-community/antsibull-docs)](https://api.reuse.software/info/github.com/ansible-community/antsibull-docs)
 
-Tooling for building Ansible documentation. This is mainly the `antsibull-docs` command and the [Sphinx extension](https://www.sphinx-doc.org/en/master/), ``sphinx_antsibull_ext``. Please check out the [documentation](https://ansible.readthedocs.io/projects/antsibull-docs/) for more information.
+Tooling for building Ansible documentation. This is mainly the `antsibull-docs` command and the [Sphinx extension](https://www.sphinx-doc.org/en/master/), ``sphinx_antsibull_ext``. Please check out the [documentation](https://docs.ansible.com/projects/antsibull-docs/) for more information.
 
-You can find a list of changes in [the antsibull-docs changelog](https://ansible.readthedocs.io/projects/antsibull-docs/changelog/).
+You can find a list of changes in [the antsibull-docs changelog](https://docs.ansible.com/projects/antsibull-docs/changelog/).
 
-antsibull-docs is covered by the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
+antsibull-docs is covered by the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html).
 
 ## Community
 
-Need help or want to discuss the project? See our [Community guide](https://ansible.readthedocs.io/projects/antsibull-docs/community/) to learn how to join the conversation!
+Need help or want to discuss the project? See our [Community guide](https://docs.ansible.com/projects/antsibull-docs/community/) to learn how to join the conversation!
 
 ## Versioning and compatibility
 

changelogs/fragments/428-urls.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - "Adjust docs.ansible.com URLs to the new ``projects/`` structure (https://github.com/ansible-community/antsibull-docs/pull/428)."

docs/ansible-output.md

@@ -95,7 +95,7 @@ Also take a look at the example further below which demonstrates all of them.
   This is explained in more detail in the [Post-processing ansible-playbook output section](#post-processing-ansible-playbook-output).
 
 * The `inventory` key allows to define a YAML inventory. See the
-  [Ansible documentation on inventories](https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html)
+  [Ansible documentation on inventories](https://docs.ansible.com/projects/ansible/latest/inventory_guide/intro_inventory.html)
   for the format of a YAML inventory.
 
 An example looks like this. The `console` code block contains the generated result:
@@ -314,14 +314,14 @@ Out of the box, you can post-process the `ansible-playbook` output in some ways:
 * Prepend lines to the output (`prepend_lines`).
 
 This, together with chosing an appropriate callback plugin
-(like [community.general.tasks_only](https://docs.ansible.com/ansible/devel/collections/community/general/tasks_only_callback.html))
+(like [community.general.tasks_only](https://docs.ansible.com/projects/ansible/devel/collections/community/general/tasks_only_callback.html))
 gives you a lot of freedom to get the output you want.
 
 In some cases, it is not sufficient though.
-For example, if you want to extract YAML output, and present it in a way that [matches your yamllint configuration](https://ansible.readthedocs.io/projects/antsibull-nox/config-file/#yamllint-part-of-the-yamllint-session).
+For example, if you want to extract YAML output, and present it in a way that [matches your yamllint configuration](https://docs.ansible.com/projects/antsibull-nox/config-file/#yamllint-part-of-the-yamllint-session).
 The default callback's YAML output suffers from [PyYAML's list indentation issue](https://github.com/yaml/pyyaml/issues/234),
 which causes problems with many yamllint configurations.
-Also, the [ansible.builtin.default callback's YAML output](https://docs.ansible.com/ansible/devel/collections/ansible/builtin/default_callback.html#parameter-result_format) is indented by 4 spaces,
+Also, the [ansible.builtin.default callback's YAML output](https://docs.ansible.com/projects/ansible/devel/collections/ansible/builtin/default_callback.html#parameter-result_format) is indented by 4 spaces,
 while most YAML is expected to be indented by 2 spaces.
 
 If you use the above settings (`skip_first_lines` / `skip_last_lines`) to extract only the YAML content of one task of the playbook's output,

docs/collection-docs.md

@@ -19,7 +19,7 @@ $ . ~/antsibull-demo-venv/bin/activate
 $ python -m pip install ansible-core antsibull-docs
 ```
 
-To install collections, you can either use [`ansible-galaxy collection install`](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html), or you can provide the collection repositories in a path structure that allows ansible-core to access them. If you work on collections, the second approach is usually preferred. One way of doing this is create a directory structure `ansible_collections/<namespace>/<name>` for a collection `<namespace>.<name>` and point Ansible's [`ANSIBLE_COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths) to the directory containing `ansible_collections`. Then you can directly use the collection in Ansible.
+To install collections, you can either use [`ansible-galaxy collection install`](https://docs.ansible.com/projects/ansible/latest/collections_guide/collections_installing.html), or you can provide the collection repositories in a path structure that allows ansible-core to access them. If you work on collections, the second approach is usually preferred. One way of doing this is create a directory structure `ansible_collections/<namespace>/<name>` for a collection `<namespace>.<name>` and point Ansible's [`ANSIBLE_COLLECTIONS_PATH`](https://docs.ansible.com/projects/ansible/latest/reference_appendices/config.html#collections-paths) to the directory containing `ansible_collections`. Then you can directly use the collection in Ansible.
 
 For example, if you want to store the collection tree in `~/collections/`, and you want to work on say `community.crypto`, which is stored in the [ansible-collections/community.crypto GitHub repository](https://github.com/ansible-collections/community.crypto/), you can clone it as follows:
 ```console
@@ -60,7 +60,7 @@ antsibull-docs internally uses `ansible-doc` and its JSON output to extract coll
 
 ## Linting collection docs
 
-While the [`validate-modules` sanity test](https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/validate-modules.html) provided by `ansible-test` already does some validation of module and plugin documentation, it does not check filter and test plugins, for example, and does not check cross-references to other plugins, modules, and roles. antsibull-docs provides the `lint-collection-docs` subcommand that allows you to extensively validate collection documentation, including extra documentation and collection-level links (see the corresponding sections below). The basic usage is as follows:
+While the [`validate-modules` sanity test](https://docs.ansible.com/projects/ansible/latest/dev_guide/testing/sanity/validate-modules.html) provided by `ansible-test` already does some validation of module and plugin documentation, it does not check filter and test plugins, for example, and does not check cross-references to other plugins, modules, and roles. antsibull-docs provides the `lint-collection-docs` subcommand that allows you to extensively validate collection documentation, including extra documentation and collection-level links (see the corresponding sections below). The basic usage is as follows:
 ```console
 $ cd ~/collections/ansible_collections/community/crypto
 $ antsibull-docs lint-collection-docs --plugin-docs .

docs/community.md

@@ -14,10 +14,10 @@ Join the [Ansible Forum](https://forum.ansible.com) as a single starting point a
 
 * [Posts tagged with 'antsibull'](https://forum.ansible.com/tag/antsibull): subscribe to participate in project-related conversations.
 * [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
-* [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events. The [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn), which is used to announce releases and important changes, can also be found here.
+* [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events. The [Bullhorn newsletter](https://docs.ansible.com/projects/ansible/devel/community/communication.html#the-bullhorn), which is used to announce releases and important changes, can also be found here.
 
 For more information on the forum navigation, see the [Navigating the Ansible forum](https://forum.ansible.com/t/navigating-the-ansible-forum-tags-categories-and-concepts/39) post.
 
 ## Matrix
 
-For real-time interactions, join the [#antsibull:ansible.com Matrix room](https://matrix.to/#/#antsibull:ansible.com). See the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html#real-time-chat) for more information on Matrix.
+For real-time interactions, join the [#antsibull:ansible.com Matrix room](https://matrix.to/#/#antsibull:ansible.com). See the [Ansible communication guide](https://docs.ansible.com/projects/ansible/devel/community/communication.html#real-time-chat) for more information on Matrix.

docs/index.md

@@ -13,7 +13,7 @@ This package provides tooling for validating and building Ansible documentation.
 
 **Collection maintainers and authors should look at the [Creating a collection docsite](collection-docs.md) section of this docsite.**
 
-antsibull-docs is covered by the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
+antsibull-docs is covered by the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html).
 
 !!! note
     Need help or want to discuss the project? See our [Community guide](community.md) to learn how to join the conversation!
@@ -22,7 +22,7 @@ antsibull-docs is covered by the [Ansible Code of Conduct](https://docs.ansible.
 
 The main CLI tool, `antsibull-docs`, has multiple subcommands:
 
-* The `devel` and `stable` subcommands are used for building the official Ansible docsites at [docs.ansible.com/ansible/devel](https://docs.ansible.com/ansible/devel/) and [docs.ansible.com/ansible/latest](https://docs.ansible.com/ansible/latest/).
+* The `devel` and `stable` subcommands are used for building the official Ansible docsites at [docs.ansible.com/projects/ansible/devel](https://docs.ansible.com/projects/ansible/devel/) and [docs.ansible.com/projects/ansible/latest](https://docs.ansible.com/projects/ansible/latest/).
 * The `current` and `collection` subcommands are used for building docsites for individual collections.
 * The `plugin` and `collection-plugins` subcommands are used for rendering documentation for individual (or all) plugins, modules, or roles.
 * The `lint-collection-docs` and `lint-core-docs` subcommands are used for linting collection and ansible-core documentation.

docs/package-docs.md

@@ -6,7 +6,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 
 # The official Ansible docsite
 
-antsibull-docs is used in the build pipeline of the official Ansible docsites at [docs.ansible.com/ansible/devel](https://docs.ansible.com/ansible/devel/) and [docs.ansible.com/ansible/latest](https://docs.ansible.com/ansible/latest/) to generate the documentation for all collections included in Ansible. It is also used for the [ansible-core documentation](https://docs.ansible.com/ansible-core/devel/) to generate the documentation for `ansible.builtin`, the collection included with ansible-core.
+antsibull-docs is used in the build pipeline of the official Ansible docsites at [docs.ansible.com/projects/ansible/devel](https://docs.ansible.com/projects/ansible/devel/) and [docs.ansible.com/projects/ansible/latest](https://docs.ansible.com/projects/ansible/latest/) to generate the documentation for all collections included in Ansible. It is also used for the [ansible-core documentation](https://docs.ansible.com/projects/ansible-core/devel/) to generate the documentation for `ansible.builtin`, the collection included with ansible-core.
 
 The RST sources for all other files of the Ansible docsite can be found in the [ansible/ansible-documentation GitHub repository](https://github.com/ansible/ansible-documentation/). This repository also contains the docsite build scripts. antsibull-docs is called from [hacking/build_library/build_ansible/command_plugins/docs_build.py](https://github.com/ansible/ansible-documentation/blob/devel/hacking/build_library/build_ansible/command_plugins/docs_build.py). This uses the `devel` and `stable` subcommands of antsibull-docs. For its input, data from the [ansible-community/ansible-build-data GitHub repository](https://github.com/ansible-community/ansible-build-data) is used. For building stable docs for a major Ansible version `$X`, the latest `ansible-$X.$Y.$Z.deps` file in the `$X/` directory in `ansible-build-data` is used. For building the `devel` docs, the list of collections is used from the latest `$Y/ansible.in` file in `ansible-build-data` with the largest `$Y` that can be found in the repository. Then the latest version of every collection listed in `$Y/ansible.in` is used.
 

mkdocs.yml

@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 site_name: antsibull-docs – Ansible Documentation Build Scripts
-site_url: https://ansible.readthedocs.io/projects/antsibull-docs
+site_url: https://docs.ansible.com/projects/antsibull-docs/
 repo_url: https://github.com/ansible-community/antsibull-docs
 theme:
   name: ansible

pyproject.toml

@@ -65,9 +65,9 @@ name = "Maxwell G"
 email = "maxwell@gtmx.me"
 
 [project.urls]
-"Documentation" = "https://ansible.readthedocs.io/projects/antsibull-docs/"
+"Documentation" = "https://docs.ansible.com/projects/antsibull-docs/"
 "Source code" = "https://github.com/ansible-community/antsibull-docs"
-"Code of Conduct" = "https://docs.ansible.com/ansible/latest/community/code_of_conduct.html"
+"Code of Conduct" = "https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html"
 "Bug tracker" = "https://github.com/ansible-community/antsibull-docs/issues"
 "Changelog" = "https://github.com/ansible-community/antsibull-docs/tree/main/CHANGELOG.md"
 

src/antsibull_docs/data/docsite/simplified-rst/plugin-redirect.rst.j2

@@ -19,9 +19,9 @@
 - This redirect is part of ``ansible-core`` and included in all Ansible
   installations. In most cases, you can use the short module name
   ``@{ plugin_name.rsplit('.', 1)[-1] }@``{% if plugin_type == 'module' %} even without specifying the `collections keyword
-  <https://docs.ansible.com/ansible/latest/collections_guide/collections_using_playbooks.html#using-collections-in-playbooks>`__{% endif %}.
+  <https://docs.ansible.com/projects/ansible/latest/collections_guide/collections_using_playbooks.html#using-collections-in-playbooks>`__{% endif %}.
   Despite that, we recommend you use the `Fully Qualified Collection Name (FQCN)
-  <https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#term-Fully-Qualified-Collection-Name-FQCN>`__
+  <https://docs.ansible.com/projects/ansible/latest/reference_appendices/glossary.html#term-Fully-Qualified-Collection-Name-FQCN>`__
   ``@{ plugin_name }@`` for easy linking to the {% if plugin_type == 'module' %}module{% else %}plugin{% endif %}
   documentation and to avoid conflicting with other collections that may have
   the same module name.