Package list python-castellan / 68b8f53
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 * 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. 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: If5b3ea5c50a91f623b0dd4d1dd347ee8a6b90290 Andreas Jaeger 1 year, 4 months ago
3 changed file(s) with 14 addition(s) and 20 deletion(s). Raw diff Collapse all Expand all
0 sphinx>=1.8.0,!=2.1.0 # BSD
0 sphinx>=2.0.0,!=2.1.0 # BSD
11 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
2 reno>=2.5.0 # Apache-2.0
3 openstackdocstheme>=1.18.1 # Apache-2.0
2 reno>=3.1.0 # Apache-2.0
3 openstackdocstheme>=2.2.1 # Apache-2.0
4747 add_module_names = True
4848
4949 # The name of the Pygments (syntax highlighting) style to use.
50 pygments_style = 'sphinx'
50 pygments_style = 'native'
5151
5252 # -- Options for HTML output --------------------------------------------------
5353
5858
5959 # Output file base name for HTML help builder.
6060 htmlhelp_basename = '%sdoc' % project
61
62 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
63 # using the given strftime format.
64 # html_last_updated_fmt = '%b %d, %Y'
65 html_last_updated_fmt = '%Y-%m-%d %H:%M'
6661
6762 # Add any paths that contain "extra" files, such as .htaccess or
6863 # robots.txt.
8984 #intersphinx_mapping = {'https://docs.python.org/3/': None}
9085
9186 # -- Options for openstackdocstheme -------------------------------------------
92 repository_name = 'openstack/castellan'
93 bug_project = 'castellan'
94 bug_tag = ''
87 openstackdocs_repo_name = 'openstack/castellan'
88 openstackdocs_pdf_link = True
89 openstackdocs_auto_name = False
90 openstackdocs_bug_project = 'castellan'
91 openstackdocs_bug_tag = ''
5151 master_doc = 'index'
5252
5353 # General information about the project.
54 repository_name = 'openstack/castellan'
55 bug_project = 'castellan'
56 bug_tag = 'doc'
54 openstackdocs_repo_name = 'openstack/castellan'
55 openstackdocs_auto_name = False
56 openstackdocs_bug_project = 'castellan'
57 openstackdocs_bug_tag = 'doc'
5758 project = u'Castellan Release Notes'
5859 copyright = u'2017, Castellan Developers'
5960
9495 # show_authors = False
9596
9697 # The name of the Pygments (syntax highlighting) style to use.
97 pygments_style = 'sphinx'
98 pygments_style = 'native'
9899
99100 # A list of ignored prefixes for module index sorting.
100101 # modindex_common_prefix = []
142143 # .htaccess) here, relative to this directory. These files are copied
143144 # directly to the root of the documentation.
144145 # html_extra_path = []
145
146 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147 # using the given strftime format.
148 html_last_updated_fmt = '%Y-%m-%d %H:%M'
149146
150147 # If true, SmartyPants will be used to convert quotes and dashes to
151148 # typographically correct entities.