Add HIDDEN status to SupportStatus and it's supporting
in code: hiding objects with HIDDEN status in docs and
resousce-type-list.
bp deprecating-improvements
Change-Id: Iebd77d769966bab321aeaf3e23b7f54e9456ad13
Now that we moved the template_guide in-tree, the hotref sphinx
directive doesn't work anymore and isn't needed. This replaces it with
ref directives and a missing-reference handler managing resources.
Change-Id: I5cba4b96894878a57d577c74dd6ade7fd252b164
This change stops generating JSON (cfn) and YAML example snippets
for resource types. These are ancient and only cause clutter in
the docs.
Change-Id: I94d3a3400f0e9ba8404c2da4364e5f9acc7dc4b2
This change adds a new page to the sphinx documentation that lists all
the resources that are not officially supported, such as those marked as
deprecated, unsupported, prototype, etc.
Change-Id: I0a14899f4f9e1539242f898f2d74d2677689d260
Allocation of contributed resources generates
incorrectly, so this patch fixes res allocation.
Now contributed resources are in Contributed Heat
Resource Types page and integrated are in OpenStack
Resource Types page. Escaping from using env because
of all_resources loaded from PluginMapping.
Change-Id: I6d7c501f231c546f909c3ed7f19fc8d1fc04e927
Closes-bug: #1433675
SupportStatus message is omitted when status equals
SUPPORTED. Also, patch adds SupportStatus note to
attribute schema.
Change-Id: I63160b21f9043e5a8d9cd35b4825c5d9abd9a6ed
Closes-bug: #1434454
I thought we already had this, but inspection of the generated docs
reveals that we only do class-level docs for the support status,
not exposing those defined in the schema.
Adding the properties support status should help reduce user confusion
when new properties are added between releases.
Change-Id: I5f3228161e57daad73cbafc124c4fad05c68d3d6
Closes-Bug: 1376868
This re-enables doc generation for contrib plugins and removes legacy
code no longer needed because of stevedore.
Related-Bug: 1403897
Change-Id: Ia51cb7c8b0c375d2a430d45b9ece50eb67271788
This patch adds admonitions to the template_guide to indicate support
status of resources to the reader. Deprecated resources will be clearly
indicated, as well as the version in which a resource appeared.
This patch also rework the generated markup to use paragraph nodes
instead of inline nodes inside notes.
Closes-Bug: #1360561
Change-Id: I5ee9fd47f0aa9627beb842dc46aa3bac10060e13
Don't create empty properties fields in the resources samples.
This patch will help resolve niceness gates failures when generating the
docbook HOT reference.
Change-Id: I3c74fa583ac55dc0a23520ec07f5d07e3d1b6fab
Closes-Bug: #1360558
Create the literal_block nodes with a 'language' attribute to add syntax
highlighting in the generated documentation.
This change is not visible in the HTML output, but is used when the
generated XML is imported in the openstack-manuals hot-reference book
(WIP).
The 'hot' language is not currently supported in sphinx or in the
manuals, but it doesn't hurt to have it and it could be implemented
later.
Change-Id: Ie5d4ab31665da812ccd7ec1232d3858786170477
Implements: blueprint heat-templates
Closes-Bug: #1360559
Include warning about updates not being supported for a propety
based on its `immutable` value being True.
Change-Id: I10fe495a2a35429b3d6e254c23ae91732e2e4dd8
Implements: blueprint implement-aws-updates-not-supported
In order to make the generated documentation for resource plug-ins more
readable, parse the class comments as RST and append to the section.
Change-Id: Icb37344c64c21bcac536e8f2916b102eb9754851
This patch makes sure that the <emphasis> tags used in the resources
generator are embeded in a <paragraph>.
This change makes it easier to convert from docutils XML to docbook by
providing a valid XML tree.
Change-Id: Icd48d8cc6d868f484de895a07bd696e951884109
This patch fixes all the missed and newly introduced violations of the H306
style checking rule and enables it in tox.
Change-Id: I5566e66421d5397c0103958f02ea38e6e3c68892
Implements: blueprint reduce-flake8-ignored-rules (partial)
At now attributes have their own Schema class with support_status
option. This information should be displayed in documentation.
Current change makes possible to use new schema for building
documentation.
Change-Id: I40af79b57defb99c7b131583b5fedfd3a67968d1
Closes-Bug: #1306383
'message' attribute of SupportStatus class has default value equal None.
If you use support_status value in Schema class without providing
'message', you will get in documentation warning in form: DEPRECATED - None.
It looks confused and in such case we should display only 'status'
attribute: DEPRECATED.
Change-Id: I482fe6a9ca134e9e3bc54282b4b10ed98c29b028
Extend write_autodoc_index to take the contrib plugins into account
and force load all resources - both built-in and contrib - in
ext/resources.py.
Co-Authored-By: Richard Lee <rblee88@gmail.com>
Partial-Bug: #1271226
Change-Id: If93dcae52bc573e2673d7fd76a0db62d5fc68115
Deprecated properties are now:
- sorted at the bottom of the properties list
- not included in the syntax examples
- include a Note: DEPRECATED - message in the property description
Change-Id: Ie3e0a7952a58469342ecdf20e2e325a0709b12f7
There is currently some function duplication in Heat for schema
validation. There is properties.Schema and a ParamSchema class which
do mostly the same, but each with their own code.
It would be good to have a common implementation for property and
parameter validation with only property or parameter specific code
implemented in sub-classes.
The current Schema class in properties.py cannot be used in
parameters.py due to cyclic import dependencies that would arise.
This patch factors the Schema class and Constraint classes into their
own file which can then be imported by both properties.py and
parameters.py. For property schema specific code, a class
PropertySchema is introduced as derived from the common Schema class.
The code of the Schema and Constraint classes is unchanged except for
absolutely refactoring work.
In a subsequent patch, I plan to provide the code to base ParamSchema
on the common Schema class.
Change-Id: I833edd8fad316220f56d6727fe1e3409f8fda6ee
Partial-Bug: #1230229
This is similar to other projects, and removes this
code from the withering gaze of coverage reports.
Change-Id: Ie0acb2a203f2e69a7d84aba3915a8499ab51ecb6
This allows any part of the resource type documentation
to be hyperlinked to.
Properties and attributes have also been moved above the syntax
examples.
Change-Id: Ie0fa2a1134be283a6c99ac2effcc869304d28f09
Implements a resourcepages directive which generates resource type
documentation for any type that matches the specified type prefix.
For example:
.. resourcepages:: OS::
Implements blueprint generate-resource-docs
Change-Id: I3b2c94a766686e17e2bdbe8be27657decd65bb3e
Peter Razumovsky
Thomas Herve
Steve Baker
Rabi Mishra
Doug Hellmann
Miguel Grinberg
Tetiana Lashchova
huangtianhua
Steven Hardy
Anderson Mesquita
Gauvain Pocentek
Ethan Lynn
Pavlo Shchelokovskyy
Randall Burt
Sergey Kraynev
Jason Dunsmore
Zane Bitter
Thomas Spatzier
Angus Salkeld