Commit Graph

96 Commits

Author SHA1 Message Date
Tony Breeds ace5ca6578 Retire Packaging Deb project repos
This commit is part of a series to retire the Packaging Deb
project. Step 2 is to remove all content from the project
repos, replacing it with a README notification where to find
ongoing work, and how to recover the repo if needed at some
future point (as in
https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project).

Change-Id: I1531aed08fc23dbcb04550285f9d41993cd10af4
2017-09-12 16:04:06 -06:00
Jenkins a67ed2f235 Merge "Removes unnecessary utf-8 encoding" 2017-06-13 19:46:05 +00:00
Sean Dague ce1252fcfc Fix for sphinx 1.6.2
This changes things to work on sphinx 1.6.2, should still work on
sphinx 1.5.1.

Change-Id: I6547877ad46d008616458a5f3b52105ab4f55c28
2017-06-13 15:22:12 -04:00
OpenStack Proposal Bot 199b7b38ee Updated from global requirements
Change-Id: Ia72b20f09855fceb00842de50d907bf8e0f2a421
2017-05-17 03:55:58 +00:00
Jenkins 3ea3617ce0 Merge "Updated from global requirements" 2017-05-16 16:43:50 +00:00
OpenStack Proposal Bot 01c4c9719b
Updated from global requirements
Change-Id: I265dc12ea83f23620bedba986fa13685b2ee9203
2017-05-16 17:32:32 +01:00
gengchc2 a9c8604bb8
Replaces yaml.load() with yaml.safe_load()
Python objects returned with Yaml.load() may be dangerous if you receive
a YAML document from an untrusted source such as the Internet.
The function yaml.safe_load() limits this ability to simple Python
objects like integers or lists.

In ordered_load we're adding a custom class so we have to use yaml.load.
In order to make it safe, set the base class to SafeLoader instead of
Loader.

Reference:
https://security.openstack.org/guidelines/dg_avoid-dangerous-input-parsing-libraries.html

Co-Authored-By: Monty Taylor <mordred@inaugust.com>
Change-Id: I3d5df9898c72c59ddab0ac7562b953e91f470220
2017-05-12 14:12:05 -05:00
Monty Taylor 32101d84c1
Update tests for more recent sphinx
The html output now uses a more compact form for empty col elements.
Update the tests to account for this.

Change-Id: I055254463e48cc8fdd44c4de7c39595a574afa47
2017-05-12 14:07:22 -05:00
Jenkins dea2b803ff Merge "Enable warnings as errors" 2017-03-22 13:32:35 +00:00
Andreas Jaeger 2ae8d1f2dd Enable warnings as errors
Tread warnings as errors for doc building - adding Sphinx'
warning-is-errors variable.

Depends-On: I7cd969fb4c9d4bff995c34725cfb739cccaba12c
Change-Id: I6cb290cdfd84eaed76b0377cb1141c4d5e0f14d3
2017-03-03 13:41:06 +00:00
OpenStack Proposal Bot d66cb0fe62 Updated from global requirements
Change-Id: Ibbee70196b276c77a65239b5306b9959428450cd
2017-03-03 00:02:21 +00:00
Jenkins 3c665ab669 Merge "Update hacking" 2017-03-02 19:45:51 +00:00
ricolin 32f1083b85 [Fix gate]Update test requirement
Since pbr already landed and the old version of hacking seems not
work very well with pbr>=2, we should update it to match global
requirement.
Partial-Bug: #1668848

Change-Id: I6c7fc3cf730a5a1fcb4b40ccc406808e224dc30b
2017-03-02 22:05:31 +08:00
Andreas Jaeger 6516ab6cb9 Update hacking
Update hacking to current version as specified in global-requirements.

Change-Id: I7b9fa99016a2aeafd7f0b03c014754b49af972a0
2017-03-01 22:11:08 +01:00
Jenkins bca739ce6f Merge "Delete support py33" 2017-02-15 16:43:47 +00:00
OpenStack Proposal Bot 55a4ed4a70 Updated from global requirements
Change-Id: Ia2f7e97914659c43f7718c74aa19dbee293d12cb
2017-02-10 05:57:02 +00:00
Nam Nguyen Hoai 3e8324ac2a Delete support py33
Python33 is not supported from Mitaka as per Infra.
This patch set will delete this.

Change-Id: Ia8809983b883003d8ebb7f86644bb9884058262b
2017-02-08 10:19:23 +07:00
Jenkins a01f103f24 Merge "Import httplib from six to support Python 3" 2017-01-31 16:49:14 +00:00
Sean Dague 7aad1620ab add file on releasing the software
Change-Id: Ie7f4c93b8a38c9c69a6680c98515cebfa2474070
2017-01-20 15:54:39 -05:00
Jenkins ac2ef89c64 Merge "Fix anchor link setting url bar" 2017-01-19 13:20:24 +00:00
Jenkins b03ed7d4a7 Merge "Add Constraints support" 2017-01-18 21:13:06 +00:00
Jenkins a4122e3ed8 Merge "Removes unnecessary utf-8 encoding" 2017-01-18 20:52:33 +00:00
Jenkins 4636482fa4 Merge "Add test for missing path params" 2017-01-18 20:52:27 +00:00
Sean Dague d521256ccf Fix anchor link setting url bar
Add an explicit onclick action for anchor links so that they set the
urlbar correctly. This long standing issue really sucks in sending
around links to people from API sites.

Change-Id: I449399836d2f327188b659a266b2e860e3ebb462
2017-01-18 14:12:49 -05:00
Karen Bradshaw 2004c987ac detail/close button, bug #1618955
When ShowAll button is selected, close
button text was grayed out.
Update CSS to display readable button text, and match
the current behaviour of the detail/close button
when a single section is displayed.

Change-Id: Icd40ecae8f5007bbf3546b678a6f5f6081e89bc6
2017-01-18 08:59:06 -05:00
Jenkins e0631064db Merge "Show team and repo badges on README" 2017-01-17 18:29:00 +00:00
Cao Xuan Hoang be63992f7b Removes unnecessary utf-8 encoding
The following file(s) added utf-8 encoding but never used. So we can
remove them at all.

os_api_ref/tests/test_warnings.py
os_api_ref/tests/test_os_api_ref.py
os_api_ref/tests/test_microversions.py
os_api_ref/tests/test_basic_example.py
os_api_ref/tests/base.py
os_api_ref/__init__.py

Change-Id: If08e1b00f777a146e2c582f5a194e022a215066e
2017-01-16 10:14:24 +07:00
Flavio Percoco d12cd5cda2 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/2c85567d0e6793bc2ed0060901457af0\n'

Change-Id: Ic8d520b02653b6b8378f39cc9be7a1054fa31704
2017-01-13 14:42:27 -05:00
OpenStack Proposal Bot 88243c1a6d Updated from global requirements
Change-Id: I09f50b8f02944c3b584eb6d50b6b777a65a71105
2017-01-13 18:50:03 +00:00
shashi.kant cca9e716fd Removes unnecessary utf-8 encoding
Change-Id: I13645eff9c28c5742b4558d9197af80268d25bee
2017-01-12 11:12:44 +00:00
Dmitry Shachnev f30d53cda0 Add compatibility with docutils 0.13
In docutils 0.13.1, the get_column_widths method of Table directive
returns a tuple, where the widths array is the second item.

Also, get_column_widths now has a “if type(self.widths) == list” check,
so use the list syntax when setting the widths property.

Change-Id: I9888a649313c60257ce6dfc46cfbd2dcbf7ac189
2017-01-08 00:20:36 +03:00
Tony Breeds 54ead9f913 Add Constraints support
Adding constraints support to libraries is slightly more complex than
services as the libraries themselves are listed in upper-constraints.txt
which leads to errors that you can't install a specific version and a
constrained version.

This change adds constraints support by also adding a helper script to
edit the constraints to remove os-api-ref.

Change-Id: I7ad1c2afda29b095ff3d53db5eec7101f8816c2e
2016-12-21 12:01:43 +11:00
Yuval Brik 8aaa668262 Import httplib from six to support Python 3
In Python 3, httplib moved to http.client.
Use six in order to import the correct library on both Python 2 and
Python 3.

Change-Id: I6f43faf453809eed3f2e88fd587e941c80204793
Closes-Bug: #1623447
2016-11-06 16:12:55 +02:00
OpenStack Proposal Bot f694119d39 Updated from global requirements
Change-Id: I40c90da5ecc00fc01cf7c18848d03ffef49244ab
2016-11-01 13:33:36 +00:00
Karen Bradshaw 9c2d634246 Add test for missing path params
Add warning and test for missing path parameters.

Change-Id: I8686006339b82ed5465dd8e4d3a8b15f85ee897c
2016-10-31 12:03:01 -04:00
Graham Hayes 57c111888e microversion selector - dropdown
This does a few things:

* Change from button list to a select combo box.
** This allows users to type the number they want
* Add the ablity to tag versions to releases
** E.G. Say mitaka was released with 2.27, it will
   show in the list as "2.27 - Mitaka".
** This currently set as a config option in
   conf.py as a dict like:

  os_api_ref_release_microversions = {
      '2.27' : 'mitaka',
      '2.10': 'liberty'
  }

* Uses https://github.com/danielfarrell/bootstrap-combobox
** Apache Licenced

Change-Id: Ica7dd55cdbf413f03ea635aefb627a705132a73e
2016-10-28 12:07:57 +02:00
Dirk Mueller 533589ccd0 Sync with global-requirements
We currently have a pending conflict over the Sphinx version in g-r,
so sync with g-r manually. Overall I would suggest that this project
should follow g-r

Change-Id: I0bf1af38945ba3e52098a925ea31f6f1dc3f3fbd
2016-09-29 17:06:28 +02:00
Tony Xu b494f29f3e Update homepage with developer documentation page
Change-Id: Ic7c78e893f554d8ff9b336d61d5eb0dd36dccb43
2016-09-24 13:26:17 +08:00
Jenkins db3e83584c Merge "Expand width of API Site" 2016-09-22 20:21:54 +00:00
Anne Gentle 22bf5f2ec6 Adds an example http-status.yaml file and updates doc
Change-Id: I16413dfebdeb01a85a759969354c9c83f0f0c260
2016-09-09 01:20:37 +00:00
Thomas Bechtold 34a7f1b668 Use beautifulsoup4 instead of bs4 in test-requirements.txt
beautifulsoup4 is already in global-requirements and bs4 is just a dummy
package.

Change-Id: Ief02165797f6aae47805656d50c249aaa3fe71ad
2016-09-05 10:51:02 +02:00
Sean Dague a22ecf2e40 remove padding-top for endpoint-container
This causes a really odd vertical alignment issue. If we remove it
then the entire API line is vertically aligned.

Change-Id: I3fc2d4b234843ec226d75d5d4dd79055d33645b6
2016-08-29 09:25:29 -04:00
Jenkins 2c6dd1bc6c Merge "Add color for COPY label" 2016-08-29 13:16:28 +00:00
Anne Gentle bab707c239 Adds more info to the README to instruct authors
Change-Id: I32fc524c87fa7ea90c86e749b7791c10bd1665ac
2016-08-24 19:26:17 -07:00
Graham Hayes 8d31f26db9 Expand width of API Site
Change-Id: I3576012ebee21222e3f30f3310aeef01ca7e605b
2016-08-23 15:46:12 +01:00
Graham Hayes 80480aa29a Update docs for openstackdocstheme
Change-Id: I9c14e4ac5fe24e162edeb37b16002ae7cfbc0fac
2016-08-23 13:59:41 +01:00
Graham Hayes 916db5d19b openstackdocstheme integration
changes the output to be compatible with the new
openstackdocs theme

Change-Id: I10d90ac2f702153508bc6e607ed451c089276a4d
2016-08-19 16:22:15 +01:00
Karen Bradshaw f9241b160e Add color for COPY label
Add colors in css for COPY label.

Change-Id: Ic5c61d286c071c2fc45a5d215bef4f7344d490f8
2016-08-04 13:25:12 -04:00
Graham Hayes b100d1542f Change Layout of Path + Sub Title
With very long URI paths the wrapping either
looks weird or there is no charecter for it to
wrap on.

This moves the URI to its own line, and moves some
of the other elements aroud slightly.

Also changes the font of the subtitle to make it more apparent.

Change-Id: I36e7420224f69eaa5f4dceb18d910b40377b76c4
2016-08-02 14:52:27 +01:00
Jenkins 03f4e77f7d Merge "Added docutils to requirements" 2016-07-25 20:01:05 +00:00