Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * parallelizing building of documents Update Sphinx version as well. 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. Set openstackdocs_pdf_link to link to PDF file. Set openstackdocs_auto_name to use 'project' as name. Depends-On: https://review.opendev.org/728938 Change-Id: I76a21521eeb432c3f4089048a4635719ba6d785c
This commit is contained in:
parent
8d0ed2c1fb
commit
a2efd0b82a
@ -37,9 +37,9 @@ extensions = [
|
|||||||
'openstackdocstheme'
|
'openstackdocstheme'
|
||||||
]
|
]
|
||||||
|
|
||||||
repository_name = 'openstack/ironic'
|
openstackdocs_repo_name = 'openstack/ironic'
|
||||||
use_storyboard = True
|
openstackdocs_use_storyboard = True
|
||||||
|
openstackdocs_auto_name = False
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
openstackdocstheme>=1.31.2 # Apache-2.0
|
openstackdocstheme>=2.2.0 # Apache-2.0
|
||||||
os-api-ref>=1.4.0 # Apache-2.0
|
os-api-ref>=1.4.0 # Apache-2.0
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=3.1.0 # Apache-2.0
|
||||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
sphinxcontrib-apidoc>=0.2.0 # BSD
|
sphinxcontrib-apidoc>=0.2.0 # BSD
|
||||||
sphinxcontrib-pecanwsme>=0.10.0 # Apache-2.0
|
sphinxcontrib-pecanwsme>=0.10.0 # Apache-2.0
|
||||||
sphinxcontrib-seqdiag>=0.8.4 # BSD
|
sphinxcontrib-seqdiag>=0.8.4 # BSD
|
||||||
|
@ -59,9 +59,10 @@ apidoc_excluded_paths = [
|
|||||||
]
|
]
|
||||||
apidoc_separate_modules = True
|
apidoc_separate_modules = True
|
||||||
|
|
||||||
repository_name = 'openstack/ironic'
|
openstackdocs_repo_name = 'openstack/ironic'
|
||||||
use_storyboard = True
|
openstackdocs_use_storyboard = True
|
||||||
openstack_projects = [
|
openstackdocs_pdf_link = True
|
||||||
|
openstackdocs_projects = [
|
||||||
'bifrost',
|
'bifrost',
|
||||||
'cinder',
|
'cinder',
|
||||||
'glance',
|
'glance',
|
||||||
|
@ -47,10 +47,9 @@ try:
|
|||||||
except ImportError:
|
except ImportError:
|
||||||
openstackdocstheme = None
|
openstackdocstheme = None
|
||||||
|
|
||||||
repository_name = 'openstack/ironic'
|
openstackdocs_repo_name = 'openstack/ironic'
|
||||||
bug_project = 'ironic'
|
openstackdocs_use_storyboard = True
|
||||||
bug_tag = ''
|
openstackdocs_auto_name = False
|
||||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
|
Loading…
x
Reference in New Issue
Block a user