Change antsibull to antsibull-docs. (#31)

Author: felixfontein

.github/workflows/_shared-docs-build-pr.yml

@@ -36,10 +36,10 @@ on:
         required: false
         type: boolean
         default: false
-      init-antsibull-version:
+      init-antsibull-docs-version:
         description: |
-          The version of antsibull to use during build init. Has no effect if init-dest-dir is supplied.
-          If not supplied, the latest version from PyPI is used. If supplied, must be a git ref from the antsibull repository.
+          The version of antsibull-docs to use during build init. Has no effect if init-dest-dir is supplied.
+          If not supplied, the latest version from PyPI is used. If supplied, must be a git ref from the antsibull-docs repository.
         required: false
         type: string
       artifact-name:
@@ -209,7 +209,7 @@ jobs:
           collections: ${{ inputs.collection-name }}
           dest-dir: ${{ steps.vars.outputs.init-dir-base }}
           skip-init: ${{ steps.vars.outputs.skip-init }}
-          antsibull-version: '${{ inputs.init-antsibull-version }}'
+          antsibull-docs-version: '${{ inputs.init-antsibull-docs-version }}'
           lenient: ${{ inputs.init-lenient }}
           fail-on-error: ${{ inputs.init-fail-on-error }}
 
@@ -241,7 +241,7 @@ jobs:
           collections: ${{ inputs.collection-name }}
           dest-dir: ${{ steps.vars.outputs.init-dir-head }}
           skip-init: ${{ steps.vars.outputs.skip-init }}
-          antsibull-version: '${{ inputs.init-antsibull-version }}'
+          antsibull-docs-version: '${{ inputs.init-antsibull-docs-version }}'
           lenient: ${{ inputs.init-lenient }}
           fail-on-error: ${{ inputs.init-fail-on-error }}
 

.github/workflows/_shared-docs-build-push.yml

@@ -36,10 +36,10 @@ on:
         required: false
         type: boolean
         default: false
-      init-antsibull-version:
+      init-antsibull-docs-version:
         description: |
-          The version of antsibull to use during build init. Has no effect if init-dest-dir is supplied.
-          If not supplied, the latest version from PyPI is used. If supplied, must be a git ref from the antsibull repository.
+          The version of antsibull-docs to use during build init. Has no effect if init-dest-dir is supplied.
+          If not supplied, the latest version from PyPI is used. If supplied, must be a git ref from the antsibull-docs repository.
         required: false
         type: string
       artifact-name:
@@ -121,7 +121,7 @@ jobs:
           collections: ${{ steps.vars.outputs.col-name }}
           dest-dir: ${{ steps.vars.outputs.init-dir }}
           skip-init: ${{ steps.vars.outputs.skip-init }}
-          antsibull-version: '${{ inputs.init-antsibull-version }}'
+          antsibull-docs-version: '${{ inputs.init-antsibull-docs-version }}'
           lenient: ${{ inputs.init-lenient }}
           fail-on-error: ${{ inputs.init-fail-on-error }}
 

.github/workflows/test-action-build-init.yml

@@ -14,7 +14,7 @@ on:
 
 jobs:
   tests:
-    name: Init [ver=${{ matrix.antsibull-version }}, skip=${{ matrix.skip-init }}, lenient=${{ matrix.lenient }}, fail-on-error=${{ matrix.fail-on-error }}, dest=${{ matrix.dest }}, collections=${{ matrix.collections }}]
+    name: Init [ver=${{ matrix.antsibull-docs-version }}, skip=${{ matrix.skip-init }}, lenient=${{ matrix.lenient }}, fail-on-error=${{ matrix.fail-on-error }}, dest=${{ matrix.dest }}, collections=${{ matrix.collections }}]
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -25,8 +25,9 @@ jobs:
           - 'fake.collection'
           - 'first.collection second.collection'
         dest: ['']
-        antsibull-version:
+        antsibull-docs-version:
           - ''  # there is no default so this will be ok
+          - 1.0.0
           - main
         lenient:
           - true
@@ -63,7 +64,7 @@ jobs:
           # please keep in sync!
           dest-dir: ${{ matrix.dest || format('{0}/{1}', runner.temp, '/docsbuild') }}
           skip-init: ${{ matrix.skip-init }}
-          antsibull-version: ${{ matrix.antsibull-version }}
+          antsibull-docs-version: ${{ matrix.antsibull-docs-version }}
           lenient: ${{ matrix.lenient }}
 
       - name: assert

.test/simple-build/requirements.txt

@@ -1,10 +1,10 @@
-antsibull
+antsibull-docs
 ansible-pygments
 sphinx
 sphinx-ansible-theme
 
 # This is a package that is not likely to be installed as a dependency
-# of antsibull (which is usually used to generate this file),
+# of antsibull-docs (which is usually used to generate this file),
 # so that we can test that the additional requirements install worked.
 # Suggestions for a better candidate package are welcome!
 hvac

actions/ansible-docs-build-init/action.yml

@@ -15,25 +15,25 @@ inputs:
   skip-init:
     description: |
       If 'true', dest-dir will be assumed to already be initialized, so this action will only install
-      antsibull and the contents of the requirements.txt file in dest-dir.
+      antsibull-docs and the contents of the requirements.txt file in dest-dir.
     required: false
     default: 'false'
   fail-on-error:
     description: |
-      Corresponds to the --fail-on-error flag in antsibull. Fails if plugins cannot be parsed.
+      Corresponds to the --fail-on-error flag in antsibull-docs. Fails if plugins cannot be parsed.
       Has no effect if skip-init is true.
     required: false
     default: 'false'
   lenient:
     description: |
-      Corresponds to the --lenient flag for antsibull sphinx-init.
+      Corresponds to the --lenient flag for antsibull-docs sphinx-init.
       By default, the build process will fail on warnings unless this is set to 'true'.
       Has no effect if skip-init is true.
     required: false
     default: 'false'
-  antsibull-version:
+  antsibull-docs-version:
     description: |
-      The version of antsibull to install. When set, it refers to a git ref from which to install.
+      The version of antsibull-docs to install. When set, it refers to a git ref from which to install.
       If not set, the latest version from PyPI is installed.
     required: false
 outputs:
@@ -47,17 +47,17 @@ outputs:
 runs:
   using: composite
   steps:
-    - name: Install Antsibull and Initialize Sphinx
+    - name: Install antsibull-docs and Initialize Sphinx
       id: init
       env:
         PIP_DISABLE_PIP_VERSION_CHECK: '1'
       shell: bash
       run: |
-        echo "::group::Installing Antsibull"
-        if [[ "${{ inputs.antsibull-version }}" != "" ]] ; then
-            pip install https://github.com/ansible-community/antsibull/archive/${{ inputs.antsibull-version }}.tar.gz
+        echo "::group::Installing antsibull-docs"
+        if [[ "${{ inputs.antsibull-docs-version }}" != "" ]] ; then
+            pip install https://github.com/ansible-community/antsibull-docs/archive/${{ inputs.antsibull-docs-version }}.tar.gz
         else
-            pip install antsibull
+            pip install antsibull-docs
         fi
         antsibull-docs --version
         echo "::endgroup::"