The version option and the release option are no longer needed since
openstackdocstheme 1.20.0 . These lines were already removed from
ironic by [1].
[1] https://review.opendev.org/c/openstack/ironic/+/663474
Change-Id: Ifdb7b6e2a3a99e121f57c1fd5811422f672d4870
* turn on apidocs option for individual module docs
* crosslink to information using :doc: and :ref:
Change-Id: Ie8016623251fb0f55335c64252060d4ce966dc96
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Set openstackdocs_auto_version to not auto-version the documents.
Set openstackdocs_auto_name to use 'project' as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Change-Id: I9591e0f0215e9eb790ec2e3ea1a7ccbd55bb76d0
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build with apidoc extension
- Use newer openstackdocstheme version
- Remove Babel requirement, this is not needed.
Change-Id: I4176d8002d45449171aa5f7a7caef196ab7900d0
Minor project file structure adjustment, to move config-generator.conf
and policy-generator.conf into tools/ subdirectory.
Also exclude tools/ from dsvm jobs.
Change-Id: I3242401511b88bd9b677d9875481808783f890b8
this patch introduces an oslo.policy-based API access policy
enforcement engine to ironic-inspector.
As part of implementation, a proper oslo.context-based request
context is also generated and assigned to each request.
Short overview of changes:
- added custom RequestContext class
- extends oslo.context to handle of "is_public_api" flag
(False by default)
- added context to request in each API route
- '/continue' api sets the "is_public_api" flag to True
- added documented definitions for API access policies and their
defaults
- added enforcement of these policies on API requests
- added oslo.policy-specific entry points to setup.cfg
- added autogenerated policy sample file with defaults
- added documentation with autogenerated policies
Change-Id: Iff6f98fa9950d78608f0a7c325d132c11a1383b3
Closes-Bug: #1719812
Documentation layout aligned with the OS standards.
The configuration page refactored, configuration options
documentation automatically generated by
oslo_config.sphinxext.
Closes-Bug: #1706175
Change-Id: I544d92d64833c0887b14509063334c39a0c428f1
Takashi Kajinami