Switch to openstackdocstheme 2.2.1 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.
Disable openstackdocs_auto_name to use 'project' variable 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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Id0886a73e1bd1c8a30dd7d1f50af7c7eab90d916
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: I7b93ead6885bf7f2a71b982f2fb215456f178ec5
api-log.conf is the deprecated path for the configuration file. The
new path is /etc/monasca/monasca-log-api.conf .
So use this new path in devstack, documentation and docker.
Change-Id: I2208b7e27d3dbec38290ffb8ba66bc64a5129744
Story: 2004831
Task: 29024
Added policies and used policy enforcement engine
from monasca-common.
- Updated role_middleware to remove authorization into the routes.
- Updated unit tests and implemented some new tests.
- Added a new entry point for generating sample policy file by tox.
story: 2001233
task: 22086
Change-Id: I3d199fac244eca94fc434d19c78bc5a17e804c37
Signed-off-by: Amir Mofakhar <amofakhar@op5.com>
Commits fills in the documentation part that touches
configuring monasca-log-api. With this documentation one
can learn about possible ways and options needed to
have own monasca-log-api properly configured.
Story: 2001058
Task: 4783
Change-Id: I8ae3531fff6d70450b187a4945ce68c472db63b6
Commits fixes deprecation detail.
Actually Log API v2 was deprecated and v3 is recommended.
Previously the documentation said that v1 was deprecated
and user should use v2.
Change-Id: I3b4b1b5fea86dc47ffc4fb1777de1d2eb01eeccf
It is common for OpenStack projects to use oslo-config-generator to generate
a sample config file which contains all available configuration options.
Work items:
* removed etc/monasca/log-api.conf (it is autogenerated)
* keep all config in one place to mimic the configuration file
* added configuration files to documentation
Story: 2000970
Task: 4121
Change-Id: I8777ed6cd38739e87b19be248b9c120e84626ad1
Migration of Openstack Project is held in
*.rst files and build with Sphinx.
Following change provides:
* technical documention
* api guide
* api ref
* releasenotes
Note:
For now, generating codebase documentation is disabled.
It caused gate failures because of, yet unnown, reasons.
In order to pull this foundation, this part is skipped.
Extra:
* provided venvs descriptions to let user know what is the scope
Story: 2001058
Task: 4665
Change-Id: Ieb2b58e165de1617748d97d997af368bd91d5c0e
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Changing Popen to .check_output because of 3 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]
3. It makes the code look much better.
[1] https://review.openstack.org/#/c/457142/
[2] https://review.openstack.org/#/c/433081
Change-Id: Ice55b84d9317e9b817e8eae3877e2f6a02ec3016
Following commits not only enables running
unit tests with ostestr, like other
OS projects, but also:
* enables covarage with testr
* enables building documentation with build_sphinx commands
Additionally:
* tox.ini was organized a bit
Change-Id: I2a21f9cee0e00f7148142465a8fc131ef4ff6f44
Martin Chacon Piza