Commit Graph

44 Commits

Author SHA1 Message Date
Hervé Beraud 20ed3307d1 Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removed specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to
pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug.

/!\/!\/!\
Notice that I voluntarily added the doc directory even if no docs
are generated here because zuul will try to pull this requirements from
there first and the contained requirements are needed for reno but AFAIK
the releasenotes dir is ignored by zuul. c.f [4] for further details.
/!\/!\/!\

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: Ib224dfe036543c8ec7fe3074fe4280586d35de97
2021-01-07 13:45:33 +00:00
Andreas Jaeger 5c9eb70f6f Cleanup py27 support
The repo is now building with py3 only, so remove Py27 support.

Change-Id: I6e2eb0b0c31c3dff676241570ebe2f1e852dfc0e
2020-04-14 12:11:03 +00:00
Andreas Jaeger f2f69c47ba Cleanup repo
Remove unused content, update README.

Update requirements to what should be needed.

Change-Id: I3acd294314ba05da29611f789d75ed9fc8b21faf
2019-07-24 18:42:15 +02:00
jacky06 67d9a7711b Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest

Change-Id: I12ab3ba42683f9f75189ab597b9768ae5ec7a3fb
2019-06-18 22:22:06 +08:00
Andreas Jaeger bc1857f54e Require openstack-doc-tools 1.8.0
We need the new version to properly publish translated api-quick-start
document. require it.

Change-Id: I1bf8411843a7d31e690c3988c2d999ee33678fcd
2018-04-19 18:59:12 +02:00
Andreas Jaeger 16f8140e97 Require openstackdocstheme 1.18.1
This update fixes bug URL links, require it.

Change-Id: I6212bb96c77ff69c10ba644d6b8d567154a15079
2018-01-24 07:09:44 +01:00
Monty Taylor 7d9497a373 Generate api-ref redirects for service type aliases
We track official service type names and their historical aliases. As
api-ref is organized by service-type, it stands to reason that if a
service-type changes (or has changed) that a link might exist to the old
value.

Use the service types authority data to generate a set of redirects for
all aliases of a service to the official service type location.

Change-Id: I96a5502ca6cd3e78f996ad9b60101c907e2150cd
2017-10-22 16:23:01 +02:00
Andreas Jaeger 640cfa00b1 Update requirements for Pike
Update our requirements for Pike.

Change-Id: Ib1e5046de4a81657d69de9bb05828763103aa9aa
2017-08-02 19:17:28 +02:00
Andreas Jaeger b13184b995 Update openstackdocstheme
Update requirements, simplifiy conf.py with new theme requirement.

Change-Id: I5e49078171d92892470bc438a377f780a817a5fd
2017-06-27 07:37:52 +02:00
Andreas Jaeger dfac12405d Update sphinx version
Update to current sphinx release.

Change-Id: Ibc12cae4692269df2b2bb52d54ee33ce84cb6ed5
2017-01-14 09:08:43 +01:00
Andreas Jaeger f5639eb140 Sync with global requirements
Update pbr to newer version.

Change-Id: I352ac03342727437a0fde501c9f1af50f9284164
2016-11-10 16:36:36 -05:00
Andreas Jaeger 64ce54f22e Update requirements
Add licenses from global-requirements.

Add Babel as requirement for translations.

Update versions of our tools.

Change-Id: I2a13e69a02491713676111a316df9a437c009a4c
2016-09-22 09:18:50 +02:00
Anne Gentle 93daffe410 Updates the "API Quick Start" to become a better landing for all API docs
- Uses new openstackdocstheme configured with the api_ref sidebar.
- Updates intro text to ensure we get the same text as what was in
  the developer.openstack.org/api_ref.html landing page.
- With these changes we should be able to completely remove and redirect
  developer.openstack.org/api_ref.html to http://developer.openstack.org/api-guide/quick-start/.

Change-Id: I5ea811aac3b34774b9cdde6c0d788b12b97977bb
2016-08-31 17:38:29 +00:00
Andreas Jaeger bb8b09bd7a Drop DocBook support, swagger building
We do not need to build and publish the DocBook XML content anymore,
everything is frozen and in the process of moving to projects. Remove
set up for building of DocBook content.

This leaves the XML files still in tree, we can remove them later.

The DocBook XML gates are still setup, so some tox environments have
been made a noop.

Require openstack-doc-tools 1.0.0 which removes DocBook XML support.

Also, drop swagger building, this is not needed anymore.

Change-Id: I276953013a518a09dabb89bb8f80ef7739b4491b
2016-08-23 13:20:09 +02:00
Andreas Jaeger c50f8493d3 Require openstackdocstheme 1.4.0
Update requirement for new release.

Change-Id: I7eeabacd6b574977f0b0375af892040299245c81
2016-07-20 13:17:28 +02:00
Anne Gentle d4156fe7f8 Adds build script for Swagger JSON conversion
- This change lets us upload Swagger files for testing and
validating online.

Change-Id: Ifb570e42b29ec8f01889c982b7cd700754a0e5f7
2016-02-05 15:21:33 -05:00
Tony Breeds 063454853b Revert "Add Pillow to test-requirements.txt"
This reverts commit 47b401f9eb.

Adding Pillow to *requirements.txt was a temporary way to set the
upper bound to < 3.0.0

nodepool thick slaves and requirements have been fixed and devstack is
fixed in the patch that this depends on.

Conflicts:
	test-requirements.txt

Change-Id: I3fc4009680ace3ba9c222aa7ad8c8ff7d6794f94
Depends-On: I2bec8cf1bfeaaa6ae329704229fdeb86d26e55c7
2015-10-25 22:43:49 +11:00
Andreas Jaeger 18058105fb Update for openstackdocstheme 1.2.3
Require new version and cleanup conf.py, we do no need pwd variable
anymore.

Sync pbr requirements with global requirements. Update
openstack-doc-tools requirements, we use 0.30 everywhere else.

Change-Id: I53a222445967092e08a1b598a19e8bbe71e378a6
2015-10-06 19:48:29 +02:00
Tony Breeds 47b401f9eb Add Pillow to test-requirements.txt
Pillow isn't directly needed but it's pulled in via
 Collecting Pillow (from blockdiag>=1.5.0->nwdiag ...)
So cap as per global-requirements until https://launchpad.net/bugs/1501995
is properly fixed

Change-Id: Ie4c35d0416219eeea494db31b1485559337e353b
2015-10-02 15:03:20 +10:00
Jenkins 0899fd0135 Merge "Fix dedent for C# code, upgrade sphinx" 2015-08-03 15:32:40 +00:00
Andreas Jaeger 4288f1b9c8 Sync requirements with global requirements
Update for pbr to use recent pbr.

Change-Id: I01dc101fecf6589e4600201b92d518e1e23c1fc2
2015-07-30 19:26:44 +02:00
Tom Fifield 16b37909a4 Fix dedent for C# code, upgrade sphinx
The C# include for the .NET SDK has to be indented to follow
the standards. This patch fixes up the includes so that the
indenting is appropriate for in-line reading of snippets

Since Sphinx 1.3 is required for dedent, this changes the
test requirements for the api-site repository to upgrade
the sphinx version.

Change-Id: I539df7bc2c08ac6b31ba8ba4b7b94cf66b3d58a4
Co-Authored-By: Liang Bo <liang.bo@99cloud.net>
2015-07-27 16:21:24 +08:00
Andreas Jaeger ef0cc0b816 Remove unused blockdiag requirement
The requirement blockdiag is not used in the FirstApp, remove it.

Change-Id: I87c0503e4897c38b33034f0b2310359f16708a37
2015-04-26 16:58:59 +00:00
Jenkins 0bfbbecd57 Merge "Sync requirements with global requirements" 2015-04-23 18:33:42 +00:00
Andreas Jaeger 0b4ecc32fb Sync requirements with global requirements
Sync requirements with global requirements, remove oslosphinx since it's
not used. Remove docutils since it's not needed with better Sphinx
requirements.

Change-Id: Ia321147d2ece7c9a8d13665c8b8bdba9c185541f
2015-04-23 19:23:08 +02:00
Andreas Jaeger 5b7e98b33f Enable some doc8 tests
Enable doc8 on openstack-firstapp directory
but disable checks for overlong lines.

Change-Id: Ia2b385fc8b2bbd379086b00e6681a599ac5b317f
2015-04-21 09:35:53 +02:00
Sean M. Collins c219133376 Add "Writing your First OpenStack Application" Guide
Written during a book sprint in Taipei, from March 30th 2015
to April 3rd 2015.

Co-Authored-By: Sean M. Collins <sean@coreitpro.com>
Co-Authored-By: Tom Fifield <tom@openstack.org>
Co-Authored-By: James Dempsey <jamesd@catalyst.net.nz>
Co-Authored-By: Nick Chase <nchase@mirantis.com>
Co-Authored-By: Christian Berendt <berendt@b1-systems.de>

Implements blueprint openstack-firstapp

Change-Id: I55ae32d0c04f641c818bda4714d9bc691a98e6b1
2015-04-21 09:15:26 +10:00
OpenStack Proposal Bot 1120e3d6ce Updated from global requirements
Change-Id: I9e0cf8852da9da0f204cbc81cdcf6453db0ba742
2015-03-06 16:43:41 +00:00
OpenStack Proposal Bot ccaf78d6e7 Updated from global requirements
Change-Id: I5107f722d4ba07a68c7de3f412877e70ac40c0dd
2015-01-27 02:25:52 +00:00
OpenStack Proposal Bot 93c1a5c51a Updated from global requirements
Change-Id: Ib88c2091ed83abcff6f7692c1dc8a5bad1fa7cae
2014-10-13 23:04:40 +00:00
OpenStack Proposal Bot b0fba7bff2 Updated from global requirements
Change-Id: Ia27371480dae77c05b96fd5fa2079db407568210
2014-09-11 00:24:07 +00:00
OpenStack Proposal Bot 75d341485b Updated from global requirements
Change-Id: I28a03b41b34b327ea33d0d5784e842d4d2d9e254
2014-08-18 18:26:56 +00:00
OpenStack Proposal Bot 57dcaceac3 Updated from global requirements
Change-Id: I38e845f28f0f897b9d112dd9bd95e8249621bc67
2014-07-29 18:39:51 +00:00
OpenStack Proposal Bot e750aa5ca5 Updated from global requirements
Change-Id: I0d3043d68b3e302f8c7fae1e7ce93e15b218c929
2014-07-02 23:53:03 +00:00
Andreas Jaeger 31ba6030ec Require openstack-doc-tool 0.15
Update requirement, we need the current version

Change-Id: Idcfc2da6c2646a80eb654f71c7e6e2e346318256
2014-06-02 19:27:51 +02:00
OpenStack Proposal Bot c128c3d1cd Updated from global requirements
Change-Id: I05802dacfd01f0ad9845dedc6fe3af9c7ca31c27
2014-05-09 23:47:57 +00:00
OpenStack Proposal Bot 3939bc09dc Updated from global requirements
Change-Id: Ibe43f86c064c97ea3494c5ea7263ece1c71f5625
2014-04-19 00:03:19 +00:00
OpenStack Jenkins c474b3c365 Updated from global requirements
Change-Id: Ia1fe0328fe5fd8464af70c03bdab10496fda6a7c
2014-03-03 03:27:10 +00:00
OpenStack Jenkins 437a8989e1 Updated from global requirements
Change-Id: Idaaea149856485823643c1b13d0921cd2b6e5d25
2014-02-20 01:36:16 +00:00
OpenStack Jenkins 23edab8a81 Updated from global requirements
Change-Id: I41655c010bb4dcf6b4899a985a0c2fcaf14935db
2014-02-11 20:21:57 +00:00
OpenStack Jenkins b64a4f5be2 Updated from global requirements
Change-Id: I0892342c580854b50ecbf565c7725f6126f9974d
2014-01-29 16:56:58 +00:00
Andreas Jaeger 6f8764122f Add exceptions file
Ignore file os-object-api-1.0.wadl from validation.

Change-Id: I428b42ea0b21498cbcaf57c09642148630399069
2014-01-28 19:53:07 +01:00
OpenStack Jenkins 5c5ba6b008 Updated from global requirements
Change-Id: I072548a69f9bcb72c1c4516faf02ec0cfd562ac0
2014-01-25 03:29:00 +00:00
Andreas Jaeger 30f4240e0c Setup for openstack-doc-tools gating
Add files to allow us gating via:
tox -e checkbuild
tox -e checkniceness
etc

Enhance .gitignore to ignore files used by gating and by more
editors.

Change-Id: Id33d04f734d438d01dd5bbd784abaa213de5dbc9
2014-01-02 17:00:03 +01:00