b3b534de79
This change adds the usage of os-api-ref to the building of the API documentation, but under the doc folder, so it is possible to publish the result to readthedocs.org. This change replaces [1] until the documentation is published to readthedocs.org. Once Fenix becomes an official OpenStack project [1] can be implemented. For the moment I will abandon [1]. [1]: https://review.openstack.org/#/c/616868/ Story: 2004292 Task: #27862 Change-Id: I3144f812d0afd41d500ec7cd8fd4ba1d9c202366 Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
32 lines
888 B
Python
32 lines
888 B
Python
# This file is not used until the api-ref directory is part of
|
|
# the doc folder and the Fenix documentation is published to
|
|
# readthedocs.org
|
|
# When Fenix API documentation will be published to [1] and the
|
|
# documentation is builded according to [2] this file will be used
|
|
# again.
|
|
#
|
|
# [1]: https://docs.openstack.org/rocky/api/
|
|
# [2]: https://docs.openstack.org/doc-contrib-guide/api-guides.html
|
|
|
|
extensions = [
|
|
'os_api_ref',
|
|
'openstackdocstheme'
|
|
]
|
|
|
|
# The prefix and repo name like
|
|
repository_name = 'openstack/fenix'
|
|
# Set Launchpad bug tag, default is empty
|
|
bug_tag = ''
|
|
# The launchpad project name like
|
|
bug_project = 'fenix'
|
|
|
|
html_theme = 'openstackdocs'
|
|
html_theme_options = {
|
|
"sidebar_mode": "toc",
|
|
}
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# Must set this variable to include year, month, day, hours, and minutes.
|
|
html_last_updated_fmt = '%Y-%m-%d %H:%M' |