openstack
/
patrole
Code Issues Proposed changes

Add :special-members: directive to automodule in docs 

This patch set adds :special-members: [0] directive to automodule
command in Patrole docs, in order to correctly render documentation
like [1] which is quite important. It won't show up without
this directive [2].

[0] http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directives
[1] 337a574ad8/patrole_tempest_plugin/policy_authority.py (L37)
[2] https://docs.openstack.org/patrole/latest/framework/policy_authority.html#module-patrole_tempest_plugin.policy_authority

Change-Id: I2a69f52e903f57cced3f5ace3ec6aab3620a4e63
This commit is contained in:
Felipe Monteiro 2018-09-12 14:49:43 -06:00
parent 337a574ad8
commit 9358f74d8c
5 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/framework/policy_authority.rst
View File

@ -60,3 +60,4 @@ Implementation
.. automodule:: patrole_tempest_plugin.policy_authority
:members:
:undoc-members:
:special-members:

1
doc/source/framework/rbac_authority.rst
View File

@ -35,3 +35,4 @@ Implementation
.. automodule:: patrole_tempest_plugin.rbac_authority
:members:
:undoc-members:
:special-members:

1
doc/source/framework/rbac_utils.rst
View File

@ -176,3 +176,4 @@ Implementation
.. automodule:: patrole_tempest_plugin.rbac_utils
:members:
:private-members:
:special-members:

1
doc/source/framework/rbac_validation.rst
View File

@ -17,3 +17,4 @@ Implementation
.. automodule:: patrole_tempest_plugin.rbac_rule_validation
:members:
:private-members:
:special-members:

1
doc/source/framework/requirements_authority.rst
View File

@ -103,3 +103,4 @@ Implementation
.. automodule:: patrole_tempest_plugin.requirements_authority
:members:
:undoc-members:
:special-members: