A random value can still easily hit collision, and at least
one was found easily on the gates (gone with a recheck).
Moreover, the usage of a random target does not allow for ensuring
reproducible builds: the usage of an hash build from the node
content makes sure that the target is stable across different
runs of api-ref generation.
Change-Id: I3fcd8a4e5b0a66c9dbf34f4a4c472f3c93c46bb8
The rendered HTML changes a bit between beautifulsoup4 4.6.3 and 4.7.1.
A regular expression can handle both cases.
Change-Id: I64d4c56b480d54b50e58141999636b91b5fb4f94
For projects that have multiple APIs documented simultaneously, if
the labels are the equal on more than one version of the API build
will fail due to duplicate label.
Adding a random number to minimize the chance of duplicate label.
Change-Id: Ic8434ce79630637a878fa64307796be0f3efe6d1
rtd uses 'readthedocs' and 'readthedocssinglehtmllocalmedia' as
builder names. os-api-ref expected 'html' as builder name to
handle the css files correctly.
This change adds the support for the rtd builders.
Change-Id: I21a5144ada79c8c95846ce961169e2505db27a56
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Sphinx 1.6 deprecated using the application object to perform logging
and it will be removed in the upcoming 2.0 release. This updates our
extensions to use the recommended sphinx.util.logging instead.
Change-Id: I1cb9b6cf7fd38ce1ae09e35af0953885a6318082
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This is a mechanically generated patch to switch the documentation
jobs to use the new PTI versions of the jobs as part of the
python3-first goal.
See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html
Change-Id: Ibfd7b4f7ed01e27cad9bfb9339a6db2487a40286
Story: #2002586
Task: #24293
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.
Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.
Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.
See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html
Change-Id: I0d61c316f13b646ccbaa05d3715d66035184e1a7
Story: #2002586
Task: #24293
This resolves a deprecation warning. It also allows us to stop storing
the 'app' variable just to enable logging.
Change-Id: I53c0f0d5cc61e32a8f1ac1d48816d2c56d82cc41
- Moved to py3 by default
- Moved to testr
- Updated docs venv to match PTI
- Fixed a slight py3 compat issue
- Added py35 and py36 jobs
Change-Id: Id3a8c1c30ecfe9b6538bff6357aecca7ecd0ed81
Signed-off-by: Graham Hayes <gr@ham.ie>
Given the following 'parameters.yaml' file:
resources_query_granular:
type: string
in: query
required: false
description: |
Some description here...
min_version: 1.22
Clearly 'min_version' is indented at the wrong level. However, the error
message is pretty much useless:
Exception occurred:
File "./os_api_ref/__init__.py", line 261, in _check_yaml_sorting
if value['in'] not in sections:
TypeError: string indices must be integers, not str
It's obvious we should be saying _what_ is causing this issue. Start
doing this by way of an exception.
Change-Id: If68f82de1e3bf37b1ab89f12adf78e0d8d123674
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links
Change-Id: Ifc989878800e7327580655e13f0e31d77cc37715
The jobs are not working with Zuul v3 as is, we need
to update all job configuration and add a new job
1) Add os-api-ref-nova-src job
Replace the legacy version with a new shiny one.
2)
Avoid tox_install.sh for constraints support
Follow https://review.openstack.org/#/c/508061 to remove
tools/tox_install.sh, we can build without it.
Depends-On: I97448d681e3e48753496818fa248ee96dd36d65b
Change-Id: Ia9c8672c820a415746e43d3b1fccb2df2f574b24
This call generates the following deprecation warning:
RemovedInSphinx17Warning: sphinx.util.compat.Directive is deprecated
and will be removed in Sphinx 1.7, please use docutils' instead.
Resolve this.
Change-Id: I1083d3d6f3e646249f187a1bdade61eecc93c7e0
tox_install.sh already takes care of package installation, respecting
upper constraints. we don't need to rerun installation without
constraints afterwards.
Change-Id: I6599d1532daba8dbabbbf2a15dfb4d2b08b8c981
Currently max_version field shows text as
"Deprecated in version %s" which seems confusing to show
deprecated fields vs removed fields.
For example: if any element is removed in x version, then we
tag that element in parameter.yaml with max_version: x-1. api-ref shows
that element as "Deprecated in version x-1" which seems confusing on
below interpretation:
- is that element deprecated in x-1 version?
- is that element only deprecated in x-1 version not removed?
But actually that element is removed in x and only available till x-1 version.
- https://developer.openstack.org/api-ref/compute/?expanded=evacuate-server-evacuate-action-detail
This commit try to describe max_version filed in more clear way.
Change-Id: I388c6e27c3d15e3bee645b7b56f8142e2f16d3d6
