From a93ed3809b824edc455a8d848313d361fb93a4c7 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 14 Aug 2019 20:28:25 +0200 Subject: [PATCH] Switch output to publish-docs/html Publishing to a top-level directory has a few challenges with some new infra scripts. Let's keep those simple and change from publish-docs to publish-docs/html. this backports and adjust changes: https://review.opendev.org/676913 https://review.opendev.org/676483 https://review.opendev.org/676482 https://review.opendev.org/676960 fix also git.openstack.org links so that guides build. Depends-On: https://review.opendev.org/676489 Change-Id: I94b7bf915c0fdad0e9e2f5dd81846f45dc99194a --- .zuul.yaml | 20 ++++++------- ...ock-storage-sample-configuration-files.rst | 6 ++-- .../source/compute/api-paste.ini.rst | 2 +- .../source/compute/policy.json.rst | 2 +- .../source/compute/rootwrap.conf.rst | 2 +- .../identity/sample-configuration-files.rst | 8 ++--- .../image-service/glance-api-paste.ini.rst | 2 +- .../source/image-service/glance-api.conf.rst | 2 +- .../image-service/glance-cache.conf.rst | 2 +- .../image-service/glance-manage.conf.rst | 2 +- .../glance-registry-paste.ini.rst | 2 +- .../image-service/glance-registry.conf.rst | 2 +- .../image-service/glance-scrubber.conf.rst | 2 +- .../image-service/glance-swift.conf.rst | 2 +- .../image-service/ovf-metadata.json.rst | 2 +- .../source/image-service/policy.json.rst | 2 +- .../property-protections-policies.conf.rst | 2 +- .../property-protections-roles.conf.rst | 2 +- .../networking/sample-configuration-files.rst | 6 ++-- .../source/object-storage/account-server.rst | 2 +- .../object-storage/container-reconciler.rst | 2 +- .../object-storage/container-server.rst | 2 +- .../object-storage/container-sync-realms.rst | 2 +- .../source/object-storage/object-expirer.rst | 2 +- .../source/object-storage/object-server.rst | 2 +- .../source/object-storage/proxy-server.rst | 2 +- .../sample-configuration-files.rst | 6 ++-- .../telemetry/sample-configuration-files.rst | 8 ++--- playbooks/build-manuals-tox/post.yaml | 5 ---- test-requirements.txt | 2 +- tools/build-all-rst.sh | 4 +-- tools/build-install-guides-rst.sh | 4 +-- tools/build-rst.sh | 8 ++--- tools/publishdocs.sh | 30 ++----------------- tox.ini | 10 +++++-- 35 files changed, 67 insertions(+), 94 deletions(-) delete mode 100644 playbooks/build-manuals-tox/post.yaml diff --git a/.zuul.yaml b/.zuul.yaml index 7be8461458..86bbff9444 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -8,17 +8,17 @@ description: | Base job to build manual related documents. These build jobs invoke a tox command and expect the published content to be in - publish-docs directory. This content is published on the root of + publish-docs/html directory. This content is published on the root of the website. Note that this build job does not create a root-marker file, this has to be done by scripts called from tox. - parent: openstack-tox - success-url: publish-docs/ - post-run: playbooks/build-manuals-tox/post.yaml + parent: opendev-tox-docs + success-url: publish-docs/html/ roles: - zuul: zuul/zuul-jobs vars: + sphinx_build_dir: 'publish-docs' tox_environment: # The tox job writes the root-marker file directly and thus # needs the following variables set: @@ -28,10 +28,10 @@ ZUUL_NEWREF: '{{ zuul.ref }}' - job: - name: build-tox-manuals-checkbuild + name: build-tox-manuals-publishdocs parent: build-tox-manuals vars: - tox_envlist: checkbuild + tox_envlist: publishdocs # Templates to easily group jobs. - project-template: @@ -41,14 +41,14 @@ check: jobs: - openstack-tox-linters - - build-tox-manuals-checkbuild + - build-tox-manuals-publishdocs gate: jobs: - openstack-tox-linters - - build-tox-manuals-checkbuild - post: + - build-tox-manuals-publishdocs + promote: jobs: - - publish-openstack-manuals + - promote-openstack-manuals # Configuration for this repository, determines which jobs to run. - project: diff --git a/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst b/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst index 8501928da9..a3390037e8 100644 --- a/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst +++ b/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst @@ -29,7 +29,7 @@ service. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=mitaka-eol + https://opendev.org/openstack/cinder/raw/tag/mitaka-eol/etc/cinder/api-paste.ini policy.json ~~~~~~~~~~~ @@ -39,7 +39,7 @@ to the Block Storage service. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=mitaka-eol + https://opendev.org/openstack/cinder/raw/tag/mitaka-eol/etc/cinder/policy.json rootwrap.conf ~~~~~~~~~~~~~ @@ -50,4 +50,4 @@ privileges to those of the root user. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/rootwrap.conf?h=mitaka-eol + https://opendev.org/openstack/cinder/raw/tag/mitaka-eol/etc/cinder/rootwrap.conf diff --git a/doc/config-reference/source/compute/api-paste.ini.rst b/doc/config-reference/source/compute/api-paste.ini.rst index 108b94f3bc..c65a079772 100644 --- a/doc/config-reference/source/compute/api-paste.ini.rst +++ b/doc/config-reference/source/compute/api-paste.ini.rst @@ -7,4 +7,4 @@ The Compute service stores its API configuration settings in the .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/api-paste.ini?h=mitaka-eol + https://opendev.org/openstack/nova/raw/tag/mitaka-eol/etc/nova/api-paste.ini diff --git a/doc/config-reference/source/compute/policy.json.rst b/doc/config-reference/source/compute/policy.json.rst index 4927ab4470..04f3e76038 100644 --- a/doc/config-reference/source/compute/policy.json.rst +++ b/doc/config-reference/source/compute/policy.json.rst @@ -7,4 +7,4 @@ that apply to the Compute service. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/policy.json?h=mitaka-eol + https://opendev.org/openstack/nova/raw/tag/mitaka-eol/etc/nova/policy.json diff --git a/doc/config-reference/source/compute/rootwrap.conf.rst b/doc/config-reference/source/compute/rootwrap.conf.rst index e399f20684..7eaa36ce93 100644 --- a/doc/config-reference/source/compute/rootwrap.conf.rst +++ b/doc/config-reference/source/compute/rootwrap.conf.rst @@ -12,4 +12,4 @@ to sudo only. Configure the ``disable_rootwrap`` option in the .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/rootwrap.conf?h=mitaka-eol + https://opendev.org/openstack/nova/raw/tag/mitaka-eol/etc/nova/rootwrap.conf diff --git a/doc/config-reference/source/identity/sample-configuration-files.rst b/doc/config-reference/source/identity/sample-configuration-files.rst index 979d2e718b..4445065418 100644 --- a/doc/config-reference/source/identity/sample-configuration-files.rst +++ b/doc/config-reference/source/identity/sample-configuration-files.rst @@ -13,7 +13,7 @@ options: .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone.conf.sample?h=mitaka-eol + https://opendev.org/openstack/keystone/raw/tag/mitaka-eol/etc/keystone.conf.sample keystone-paste.ini ~~~~~~~~~~~~~~~~~~ @@ -23,7 +23,7 @@ Interface (WSGI) middleware pipeline for the Identity service: .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone-paste.ini?h=mitaka-eol + https://opendev.org/openstack/keystone/raw/tag/mitaka-eol/etc/keystone-paste.ini logging.conf ~~~~~~~~~~~~ @@ -36,7 +36,7 @@ For details, see the `Python logging module documentation .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/keystone/plain/etc/logging.conf.sample?h=mitaka-eol + https://opendev.org/openstack/keystone/raw/tag/mitaka-eol/etc/logging.conf.sample policy.json ~~~~~~~~~~~ @@ -46,4 +46,4 @@ the Identity service: .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/keystone/plain/etc/policy.json?h=mitaka-eol + https://opendev.org/openstack/keystone/raw/tag/mitaka-eol/etc/policy.json diff --git a/doc/config-reference/source/image-service/glance-api-paste.ini.rst b/doc/config-reference/source/image-service/glance-api-paste.ini.rst index 99c70b1e1e..7ad51311e0 100644 --- a/doc/config-reference/source/image-service/glance-api-paste.ini.rst +++ b/doc/config-reference/source/image-service/glance-api-paste.ini.rst @@ -9,4 +9,4 @@ You should not need to modify this file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-api-paste.ini diff --git a/doc/config-reference/source/image-service/glance-api.conf.rst b/doc/config-reference/source/image-service/glance-api.conf.rst index 54c4f2aac1..74e0573403 100644 --- a/doc/config-reference/source/image-service/glance-api.conf.rst +++ b/doc/config-reference/source/image-service/glance-api.conf.rst @@ -9,4 +9,4 @@ This file must be modified after installation. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-api.conf diff --git a/doc/config-reference/source/image-service/glance-cache.conf.rst b/doc/config-reference/source/image-service/glance-cache.conf.rst index 4597e25269..bcab848a0d 100644 --- a/doc/config-reference/source/image-service/glance-cache.conf.rst +++ b/doc/config-reference/source/image-service/glance-cache.conf.rst @@ -7,4 +7,4 @@ are found in the ``glance-cache.conf`` file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-cache.conf?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-cache.conf diff --git a/doc/config-reference/source/image-service/glance-manage.conf.rst b/doc/config-reference/source/image-service/glance-manage.conf.rst index 1c6285379b..28ed394f8d 100644 --- a/doc/config-reference/source/image-service/glance-manage.conf.rst +++ b/doc/config-reference/source/image-service/glance-manage.conf.rst @@ -15,4 +15,4 @@ are found in the ``glance-manage.conf`` file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-manage.conf?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-manage.conf diff --git a/doc/config-reference/source/image-service/glance-registry-paste.ini.rst b/doc/config-reference/source/image-service/glance-registry-paste.ini.rst index e29c4c93ef..07b8d76137 100644 --- a/doc/config-reference/source/image-service/glance-registry-paste.ini.rst +++ b/doc/config-reference/source/image-service/glance-registry-paste.ini.rst @@ -7,4 +7,4 @@ The Image service's middleware pipeline for its registry is found in the .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-registry-paste.ini diff --git a/doc/config-reference/source/image-service/glance-registry.conf.rst b/doc/config-reference/source/image-service/glance-registry.conf.rst index be12c01978..3ac639269d 100644 --- a/doc/config-reference/source/image-service/glance-registry.conf.rst +++ b/doc/config-reference/source/image-service/glance-registry.conf.rst @@ -9,4 +9,4 @@ This file must be modified after installation. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-registry.conf diff --git a/doc/config-reference/source/image-service/glance-scrubber.conf.rst b/doc/config-reference/source/image-service/glance-scrubber.conf.rst index 7baf728917..35e6d06714 100644 --- a/doc/config-reference/source/image-service/glance-scrubber.conf.rst +++ b/doc/config-reference/source/image-service/glance-scrubber.conf.rst @@ -8,4 +8,4 @@ deleted. Its configuration is stored in the ``glance-scrubber.conf`` file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-scrubber.conf diff --git a/doc/config-reference/source/image-service/glance-swift.conf.rst b/doc/config-reference/source/image-service/glance-swift.conf.rst index 76028c405a..e76fe33385 100644 --- a/doc/config-reference/source/image-service/glance-swift.conf.rst +++ b/doc/config-reference/source/image-service/glance-swift.conf.rst @@ -4,4 +4,4 @@ glance-swift.conf .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-swift.conf.sample?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/glance-swift.conf.sample diff --git a/doc/config-reference/source/image-service/ovf-metadata.json.rst b/doc/config-reference/source/image-service/ovf-metadata.json.rst index 4c467b57e9..e4bbf93b12 100644 --- a/doc/config-reference/source/image-service/ovf-metadata.json.rst +++ b/doc/config-reference/source/image-service/ovf-metadata.json.rst @@ -11,4 +11,4 @@ from the ``CIM_ProcessorAllocationSettingData`` namespace, .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/glance/plain/etc/ovf-metadata.json.sample?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/ovf-metadata.json.sample diff --git a/doc/config-reference/source/image-service/policy.json.rst b/doc/config-reference/source/image-service/policy.json.rst index 9543907ceb..b146e6c3cd 100644 --- a/doc/config-reference/source/image-service/policy.json.rst +++ b/doc/config-reference/source/image-service/policy.json.rst @@ -7,4 +7,4 @@ apply to the Image service. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/policy.json diff --git a/doc/config-reference/source/image-service/property-protections-policies.conf.rst b/doc/config-reference/source/image-service/property-protections-policies.conf.rst index deb950a7b2..222510aad4 100644 --- a/doc/config-reference/source/image-service/property-protections-policies.conf.rst +++ b/doc/config-reference/source/image-service/property-protections-policies.conf.rst @@ -4,4 +4,4 @@ property-protections-policies.conf .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-policies.conf.sample?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/property-protections-policies.conf.sample diff --git a/doc/config-reference/source/image-service/property-protections-roles.conf.rst b/doc/config-reference/source/image-service/property-protections-roles.conf.rst index 139f616178..09efe6ac84 100644 --- a/doc/config-reference/source/image-service/property-protections-roles.conf.rst +++ b/doc/config-reference/source/image-service/property-protections-roles.conf.rst @@ -4,4 +4,4 @@ property-protections-roles.conf .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-roles.conf.sample?h=mitaka-eol + https://opendev.org/openstack/glance/raw/tag/mitaka-eol/etc/property-protections-roles.conf.sample diff --git a/doc/config-reference/source/networking/sample-configuration-files.rst b/doc/config-reference/source/networking/sample-configuration-files.rst index 88e9021bcf..609eab3511 100644 --- a/doc/config-reference/source/networking/sample-configuration-files.rst +++ b/doc/config-reference/source/networking/sample-configuration-files.rst @@ -29,7 +29,7 @@ gateway interface (WSGI). .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/neutron/plain/etc/api-paste.ini?h=mitaka-eol + https://opendev.org/openstack/neutron/raw/tag/mitaka-eol/etc/api-paste.ini policy.json ~~~~~~~~~~~ @@ -38,7 +38,7 @@ The ``policy.json`` defines API access policy. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/neutron/plain/etc/policy.json?h=mitaka-eol + https://opendev.org/openstack/neutron/raw/tag/mitaka-eol/etc/policy.json rootwrap.conf ~~~~~~~~~~~~~ @@ -48,7 +48,7 @@ that require privilege escalation to execute. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/neutron/plain/etc/rootwrap.conf?h=mitaka-eol + https://opendev.org/openstack/neutron/raw/tag/mitaka-eol/etc/rootwrap.conf Reference architecture plug-ins and agents ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/config-reference/source/object-storage/account-server.rst b/doc/config-reference/source/object-storage/account-server.rst index a0ded7c5c4..adf9878d3f 100644 --- a/doc/config-reference/source/object-storage/account-server.rst +++ b/doc/config-reference/source/object-storage/account-server.rst @@ -22,4 +22,4 @@ Sample account server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=mitaka-eol + https://opendev.org/openstack/swift/raw/tag/mitaka-eol/etc/account-server.conf-sample diff --git a/doc/config-reference/source/object-storage/container-reconciler.rst b/doc/config-reference/source/object-storage/container-reconciler.rst index 78ec7bf782..d7510597b9 100644 --- a/doc/config-reference/source/object-storage/container-reconciler.rst +++ b/doc/config-reference/source/object-storage/container-reconciler.rst @@ -20,4 +20,4 @@ Sample container sync reconciler configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/container-reconciler.conf-sample?h=mitaka-eol + https://opendev.org/openstack/swift/raw/tag/mitaka-eol/etc/container-reconciler.conf-sample diff --git a/doc/config-reference/source/object-storage/container-server.rst b/doc/config-reference/source/object-storage/container-server.rst index 888f4caf40..96e846bf19 100644 --- a/doc/config-reference/source/object-storage/container-server.rst +++ b/doc/config-reference/source/object-storage/container-server.rst @@ -23,4 +23,4 @@ Sample container server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=mitaka-eol + https://opendev.org/openstack/swift/raw/tag/mitaka-eol/etc/container-server.conf-sample diff --git a/doc/config-reference/source/object-storage/container-sync-realms.rst b/doc/config-reference/source/object-storage/container-sync-realms.rst index e9e0a73c7e..6a862a5a50 100644 --- a/doc/config-reference/source/object-storage/container-sync-realms.rst +++ b/doc/config-reference/source/object-storage/container-sync-realms.rst @@ -16,4 +16,4 @@ Sample container sync realms configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/container-sync-realms.conf-sample?h=mitaka-eol + https://opendev.org/openstack/swift/raw/tag/mitaka-eol/etc/container-sync-realms.conf-sample diff --git a/doc/config-reference/source/object-storage/object-expirer.rst b/doc/config-reference/source/object-storage/object-expirer.rst index 805914f0f0..456a601bef 100644 --- a/doc/config-reference/source/object-storage/object-expirer.rst +++ b/doc/config-reference/source/object-storage/object-expirer.rst @@ -20,4 +20,4 @@ Sample object expirer configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/object-expirer.conf-sample?h=mitaka-eol + https://opendev.org/openstack/swift/raw/tag/mitaka-eol/etc/object-expirer.conf-sample diff --git a/doc/config-reference/source/object-storage/object-server.rst b/doc/config-reference/source/object-storage/object-server.rst index fd61f4a701..ff288cbe85 100644 --- a/doc/config-reference/source/object-storage/object-server.rst +++ b/doc/config-reference/source/object-storage/object-server.rst @@ -22,4 +22,4 @@ Sample object server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=mitaka-eol + https://opendev.org/openstack/swift/raw/tag/mitaka-eol/etc/object-server.conf-sample diff --git a/doc/config-reference/source/object-storage/proxy-server.rst b/doc/config-reference/source/object-storage/proxy-server.rst index 21d1359ce2..5c3898dab2 100644 --- a/doc/config-reference/source/object-storage/proxy-server.rst +++ b/doc/config-reference/source/object-storage/proxy-server.rst @@ -29,4 +29,4 @@ Sample proxy server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=mitaka-eol + https://opendev.org/openstack/swift/raw/tag/mitaka-eol/etc/proxy-server.conf-sample diff --git a/doc/config-reference/source/shared-file-systems/sample-configuration-files.rst b/doc/config-reference/source/shared-file-systems/sample-configuration-files.rst index 4e52181617..19421c366c 100644 --- a/doc/config-reference/source/shared-file-systems/sample-configuration-files.rst +++ b/doc/config-reference/source/shared-file-systems/sample-configuration-files.rst @@ -25,7 +25,7 @@ service. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/api-paste.ini?h=mitaka-eol + https://opendev.org/openstack/manila/raw/tag/mitaka-eol/etc/manila/api-paste.ini policy.json ----------- @@ -35,7 +35,7 @@ to the Shared File Systems service. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/policy.json?h=mitaka-eol + https://opendev.org/openstack/manila/raw/tag/mitaka-eol/etc/manila/policy.json rootwrap.conf ------------- @@ -46,4 +46,4 @@ its privileges to those of the root user. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/rootwrap.conf?h=mitaka-eol + https://opendev.org/openstack/manila/raw/tag/mitaka-eol/etc/manila/rootwrap.conf diff --git a/doc/config-reference/source/telemetry/sample-configuration-files.rst b/doc/config-reference/source/telemetry/sample-configuration-files.rst index 1c68867dd9..8538f0bc4f 100644 --- a/doc/config-reference/source/telemetry/sample-configuration-files.rst +++ b/doc/config-reference/source/telemetry/sample-configuration-files.rst @@ -28,7 +28,7 @@ traits that operators may find useful. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml?h=mitaka-eol + https://opendev.org/openstack/ceilometer/raw/tag/mitaka-eol/etc/ceilometer/event_definitions.yaml pipeline.yaml ~~~~~~~~~~~~~ @@ -42,7 +42,7 @@ generated by the Telemetry module. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml?h=mitaka-eol + https://opendev.org/openstack/ceilometer/raw/tag/mitaka-eol/etc/ceilometer/pipeline.yaml event_pipeline.yaml ~~~~~~~~~~~~~~~~~~~ @@ -56,7 +56,7 @@ where to publish the events. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_pipeline.yaml?h=mitaka-eol + https://opendev.org/openstack/ceilometer/raw/tag/mitaka-eol/etc/ceilometer/event_pipeline.yaml policy.json ~~~~~~~~~~~ @@ -66,4 +66,4 @@ to the Telemetry service. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/policy.json?h=mitaka-eol + https://opendev.org/openstack/ceilometer/raw/tag/mitaka-eol/etc/ceilometer/policy.json diff --git a/playbooks/build-manuals-tox/post.yaml b/playbooks/build-manuals-tox/post.yaml deleted file mode 100644 index 75cb086fc5..0000000000 --- a/playbooks/build-manuals-tox/post.yaml +++ /dev/null @@ -1,5 +0,0 @@ -- hosts: all - roles: - - role: fetch-tox-output - - role: fetch-sphinx-output - sphinx_output_src: "{{ zuul.project.src_dir }}/publish-docs" diff --git a/test-requirements.txt b/test-requirements.txt index 1bcd79db40..1085c82380 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -14,4 +14,4 @@ openstackdocstheme>=1.2.3,< 1.8.0 doc8 # Apache-2.0 requests>=2.10.0,!=2.12.2 # Apache-2.0 requestsexceptions>=1.1.1 # Apache-2.0 -sphinxmark +sphinxmark <=0.1.17 diff --git a/tools/build-all-rst.sh b/tools/build-all-rst.sh index 77b7b273ab..2829f4751c 100755 --- a/tools/build-all-rst.sh +++ b/tools/build-all-rst.sh @@ -1,6 +1,6 @@ #!/bin/bash -e -mkdir -p publish-docs +mkdir -p publish-docs/html LINKCHECK="" if [[ $# > 0 ]] ; then @@ -29,7 +29,7 @@ MARKER_TEXT="Project: $ZUUL_PROJECT Ref: $ZUUL_BRANCH Build: $ZUUL_UUID Revision for guide in user-guide admin-guide cli-reference networking-guide config-reference ; do tools/build-rst.sh doc/$guide --build build \ --target "mitaka/$guide" $LINKCHECK - echo $MARKER_TEXT > publish-docs/mitaka/$guide/.root-marker + echo $MARKER_TEXT > publish-docs/html/mitaka/$guide/.root-marker done tools/build-install-guides-rst.sh $LINKCHECK diff --git a/tools/build-install-guides-rst.sh b/tools/build-install-guides-rst.sh index 167f5ce035..79e2631ff2 100755 --- a/tools/build-install-guides-rst.sh +++ b/tools/build-install-guides-rst.sh @@ -1,6 +1,6 @@ #!/bin/bash -e -mkdir -p publish-docs +mkdir -p publish-docs/html TAGS=${1:-obs rdo ubuntu} INDEX=doc/install-guide/source/index.rst @@ -44,5 +44,5 @@ for tag in $TAGS; do tools/build-rst.sh doc/install-guide \ $GLOSSARY --tag ${tag} --target "mitaka/install-guide-${tag}" \ $LINKCHECK - echo $MARKER_TEXT > publish-docs/mitaka/install-guide-${tag}/.root-marker + echo $MARKER_TEXT > publish-docs/html/mitaka/install-guide-${tag}/.root-marker done diff --git a/tools/build-rst.sh b/tools/build-rst.sh index a2ba86bc17..61b7d6058d 100755 --- a/tools/build-rst.sh +++ b/tools/build-rst.sh @@ -18,7 +18,7 @@ if [ -z "$DIRECTORY" ] ; then echo "usage $0 DIRECTORY options" echo "Options are:" echo "--tag TAG: Use given tag for building" - echo "--target TARGET: Copy files to publish-docs/$TARGET" + echo "--target TARGET: Copy files to publish-docs/html/$TARGET" echo "--build BUILD: Name of build directory" echo "--linkcheck: Check validity of links instead of building" exit 1 @@ -87,9 +87,9 @@ else # Copy RST if [ "$TARGET" != "" ] ; then - mkdir -p publish-docs/$TARGET - rsync -a $BUILD_DIR/ publish-docs/$TARGET/ + mkdir -p publish-docs/html/$TARGET + rsync -a $BUILD_DIR/ publish-docs/html/$TARGET/ # Remove unneeded build artefact - rm -f publish-docs/$TARGET/.buildinfo + rm -f publish-docs/html/$TARGET/.buildinfo fi fi diff --git a/tools/publishdocs.sh b/tools/publishdocs.sh index d7312e6246..659b726e30 100755 --- a/tools/publishdocs.sh +++ b/tools/publishdocs.sh @@ -19,34 +19,8 @@ if [[ -z "$PUBLISH" ]] ; then exit 1 fi -# Copy files from draft to named branch and replace all links from -# draft with links to the branch -function copy_to_branch { - BRANCH=$1 - if [ -e publish-docs/draft ] ; then - - # Copy files over - mkdir -p publish-docs/$BRANCH - cp -a publish-docs/draft/* publish-docs/$BRANCH/ - # We don't need this file - rm -f publish-docs/$BRANCH/draft-index.html - # We don't need these draft guides on the branch - rm -rf publish-docs/$BRANCH/arch-design-draft - rm -rf publish-docs/$BRANCH/ops-guide - - for f in $(find publish-docs/$BRANCH -name "atom.xml"); do - sed -i -e "s|/draft/|/$BRANCH/|g" $f - done - for f in $(find publish-docs/$BRANCH -name "*.html"); do - sed -i -e "s|/draft/|/$BRANCH/|g" $f - done - # Debian Install Guide for Mitaka is not ready - rm -rf publish-docs/$BRANCH/install-guide-debian - fi -} - -mkdir -p publish-docs +mkdir -p publish-docs/html # Build all RST guides tools/build-all-rst.sh @@ -72,5 +46,5 @@ tools/build-all-rst.sh if [ "$PUBLISH" = "build" ] ; then # Create index page for viewing - openstack-indexpage publish-docs + openstack-indexpage publish-docs/html fi diff --git a/tox.ini b/tox.ini index cc2f423abb..523f513743 100644 --- a/tox.ini +++ b/tox.ini @@ -82,6 +82,11 @@ sitepackages=True whitelist_externals = doc-tools-check-languages commands = doc-tools-check-languages doc-tools-check-languages.conf test all + # Move from publish-docs to publish-docs/html + # TODO(AJaeger): Remove once openstack-doc-tools is updated + mkdir publish-docs-new + mv publish-docs publish-docs-new/html + mv publish-docs-new publish-docs [testenv:buildlang] # Run as "tox -e buildlang -- $LANG" @@ -103,10 +108,9 @@ whitelist_externals = rmdir commands = doc-tools-check-languages doc-tools-check-languages.conf publish all - rmdir publish-docs/id publish-docs/ja + rmdir publish-docs/html/id publish-docs/html/ja # Manually move files around - mv publish-docs/draft publish-docs/mitaka - + mv publish-docs/draft publish-docs/html/mitaka [testenv:generatepot-rst] # Generate POT files for translation, needs {posargs} like: