18 Commits

Author SHA1 Message Date
Andreas Jaeger
26fc4a3f29 docs: Remove broken link
The modinfo index file does not exist, remove it from index.

Also, remove commented boilerplate.

Change-Id: I6c7ecff94f18a8301651b8b03bc90dd199226bf1
2018-09-09 16:01:26 +02:00
Graham Hayes
d6805491ed General overhaul of testing setup
- 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>
2018-06-18 14:36:12 +01:00
Andreas Jaeger
801515b979 Use openstackdocstheme
Get rid of oslosphinx, use openstackdocstheme instead like we do
in all other docs projects.

Change-Id: I4d9be1d6d02a075f36fc81e302b4ec8a92adf769
2018-01-21 16:01:40 +01:00
Tristan Cacqueray
5f3217d184 Add 'uuid' type
This change documents using 'uuid' type instead of just 'string'.

Change-Id: Iaba764a055d368120723786d276c0e2d14adbeb5
2017-12-18 01:52:57 +00:00
ghanshyam
1f71845ede Clear description for max_version field
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
2017-06-29 02:48:13 +00:00
Jenkins
a67ed2f235 Merge "Removes unnecessary utf-8 encoding" 2017-06-13 19:46:05 +00: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
shashi.kant
cca9e716fd Removes unnecessary utf-8 encoding
Change-Id: I13645eff9c28c5742b4558d9197af80268d25bee
2017-01-12 11:12:44 +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
Graham Hayes
80480aa29a Update docs for openstackdocstheme
Change-Id: I9c14e4ac5fe24e162edeb37b16002ae7cfbc0fac
2016-08-23 13:59:41 +01:00
Graham Hayes
fa30156fd6 HTTP Response Code Table
Change-Id: Ie65366c1f5cb76af50ce116c1bb8747ed610f103
2016-06-03 14:09:53 +01:00
Karen Bradshaw
b170c0016a Added more details to usage.rst
-Added info on max_version field.
-Added info about including sample files.
-Added warning test for missing lookup key.
-Added warning test for missing type field.

Change-Id: I1ffa2d3e1d425239641adbdf029647e1af72bca0
2016-06-01 14:51:23 -04:00
Sean Dague
8a80a67df6 add section on warnings
Change-Id: I3286a49dbefc56696136412272759d302dd1c431
2016-05-15 07:00:32 -04:00
Sean Dague
e5699bc8ae document parameters.yaml and rest_expand_all
Change-Id: Ib601ab9e5f449439273a20288224b60f23e4647d
2016-05-14 20:11:32 -04:00
Sean Dague
15ed94717e partial documentation on rest_parameters
Change-Id: Ibcdb1894d6df688a031894867b297d52a2560e91
2016-05-14 15:22:59 -04:00
Sean Dague
2463ec9fb6 update usage for rest_method
Change-Id: I29e7dea5b3274f4ee8a1d47524d26aafb9ad7a2a
2016-05-14 14:32:44 -04:00
Sean Dague
dec31938d0 further enhance documentation
Change-Id: I13b9f634529d4e2edd2cc75bdc528b5cebb6a1a2
2016-05-14 08:55:41 -04:00
Sean Dague
6e03e0b62d Initial Cookiecutter Commit.
Change-Id: I28402285aaeecd4eb85415a39763b2798fcfa33c
2016-05-13 19:54:08 -04:00