| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
| |
This adds the return of some metadata to our sphinx extension setup to
indicate they are thread safe. This is needed to allow consuming
projects to do multithreaded docs builds. In some cases, this can save a
noticeable amount of time in job execution.
Change-Id: I104271bc706fc33247548a147db0af05aa88737d
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Users expect this to be parsed as rST and write their docstrings accordingly.
This has the potential to introduce warnings for users with improperly
formatted rST and these warnings can be promoted to errors if 'sphinx-build' is
used with the '-W' option. As a result, we disable the 'warning-is-error'
logger for these options. We may wish to change this behavior in the future.
It is not really possible to test this yet as the output wouldn't look much
different. In addition, the error messages generated are rather unhelpful. Both
of these can be changed in a future modification.
Change-Id: I4572eef31a8675eabb791c14279490348e949cd0
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
|
| |
|
|
|
|
|
|
|
|
|
| |
Since we've added ``scope_types`` as an attribute to policy rules, it
makes sense to include this information in documentation. End users
will need to know what type of scope is required to pass a specific
policy rule when services start incorporating system scope and scope
types.
Change-Id: I86d89e9f45740b39cef04773cec8846c1ab97c3a
Closes-Bug: 1773473
|
| |
|
|
|
|
|
|
|
|
| |
Using the app error function is not enough to break the build at the
point where the error occurs. Throw an exception with an error message
explaining the problem.
Related-Bug: 1707246
Change-Id: Ie836b7a6f3ea7cba1737913b944f36c77f14cfd0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
|
| |
|
|
|
|
|
|
|
|
|
| |
When the default for a policy rule is empty, the output is ````. The
rst parser interprets that as a title overline or underline, and
sphinx dies. When we have no default rule emit a string saying so to
avoid emitting an empty literal inline block.
Closes-Bug: 1707246
Change-Id: I774b2de5ff59874dfa67811c094735dd74c8083e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
The 'sphinxext' module provided by 'oslo.config' uses field lists [1] for
its defaults. Provide some cross-promotional, deal mechanics, revenue
streams, jargon synergy between these two plugins (i.e. make them look
similar).
This message was approved by Jack Donaghy [2].
[1] http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists
[2] https://youtu.be/aocZo3oeNxw
Change-Id: I6e478152a278a877ae37588be930b0b833eb09cd
|
| |
|
|
|
|
|
|
|
|
| |
In a definition list, a term must be immediately followed by an
(indented) definition. However, the current implementation added a
newline resulting in a paragraph followed by a blockquote. Resolve this
oversight.
Change-Id: If8dae36885be23b1784b8b1d7015b92bb630abbe
Closes-Bug: #1702442
|
|
|
This will provide a more parsable sample policy file for us in docs.
This compliments the 'sphinxpolicygen' module.
Change-Id: Id99b21e7c0a66aaf4223e60074626914235e0ca5
|
