Switch to newer openstackdocstheme and reno versions
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 Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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. 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_name to use 'project' as name. Co-Authored-By: Andreas Jaeger <aj@suse.com> Change-Id: If23546ac4cc2c19626e05b460651b61d5e82d948
This commit is contained in:
jacky06
Andreas Jaeger
parent
148b0f912b
commit
c4cee86581
|
|
@ -5,7 +5,7 @@
|
|||
# changes how packages are installed. New dependencies should be
|
||||
# added in alphabetical order, however, some dependencies may need to
|
||||
# be installed in a specific order.
|
||||
openstackdocstheme>=1.19.0 # Apache-2.0
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
sphinx>=1.8.0,!=2.1.0 # BSD
|
||||
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@
|
|||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
from kolla_ansible.version import version_info as kolla_version
|
||||
import os
|
||||
import sys
|
||||
|
||||
|
|
@ -41,16 +40,6 @@ master_doc = 'index'
|
|||
project = u'kolla-ansible'
|
||||
copyright = u'2013, OpenStack Foundation'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = kolla_version.version_string_with_vcs()
|
||||
# The short X.Y version.
|
||||
version = kolla_version.canonical_version_string()
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
add_function_parentheses = True
|
||||
|
||||
|
|
@ -76,9 +65,6 @@ html_theme_options = {
|
|||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
|
||||
# Must set this variable to include year, month, day, hours, and minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass
|
||||
# [howto/manual]).
|
||||
|
|
@ -93,9 +79,10 @@ latex_documents = [
|
|||
latex_use_xindy = False
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/kolla-ansible'
|
||||
bug_project = 'kolla-ansible'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/kolla-ansible'
|
||||
openstackdocs_pdf_link = True
|
||||
openstackdocs_bug_project = 'kolla-ansible'
|
||||
openstackdocs_bug_tag = ''
|
||||
openstack_projects = [
|
||||
'bifrost',
|
||||
'cinder',
|
||||
|
|
|
|||
|
|
@ -43,7 +43,6 @@ msgpack==0.5.6
|
|||
munch==2.2.0
|
||||
netaddr==0.7.18
|
||||
netifaces==0.10.6
|
||||
openstackdocstheme==1.18.1
|
||||
openstacksdk==0.12.0
|
||||
os-client-config==1.29.0
|
||||
os-service-types==1.2.0
|
||||
|
|
@ -69,7 +68,6 @@ python-mimeparse==1.6.0
|
|||
python-subunit==1.2.0
|
||||
pytz==2013.6
|
||||
PyYAML==3.12
|
||||
reno==2.5.0
|
||||
requests==2.18.4
|
||||
requestsexceptions==1.4.0
|
||||
restructuredtext-lint==1.1.3
|
||||
|
|
@ -78,8 +76,6 @@ simplejson==3.13.2
|
|||
six==1.10.0
|
||||
smmap2==2.0.3
|
||||
snowballstemmer==1.2.1
|
||||
Sphinx==1.8.0
|
||||
sphinxcontrib-websupport==1.0.1
|
||||
sphinxcontrib-svg2pdfconverter==0.1.0
|
||||
stevedore==1.28.0
|
||||
stestr==2.0.0
|
||||
|
|
|
|||
|
|
@ -32,6 +32,12 @@ extensions = [
|
|||
'reno.sphinxext',
|
||||
]
|
||||
|
||||
# openstackdocstheme options
|
||||
openstackdocs_repo_name = 'openstack/kolla-ansible'
|
||||
openstackdocs_bug_project = 'kolla-ansible'
|
||||
openstackdocs_bug_tag = ''
|
||||
openstackdocs_auto_name = False
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
|
|
@ -134,10 +140,6 @@ html_static_path = ['_static']
|
|||
# directly to the root of the documentation.
|
||||
# html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
# html_use_smartypants = True
|
||||
|
|
|
|||
Loading…
Reference in New Issue