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. Remove docs requirements from test-requirement, it's enough to have them in doc/requirements.txt. 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: I8d4234212ecceb639e40eae423af72d2d08b010d
This commit is contained in:
parent
8583d1a698
commit
260ba07210
|
@ -1,9 +1,9 @@
|
|||
# The order of packages is significant, because pip processes them in the order
|
||||
# of appearance. Changing the order has an impact on the overall integration
|
||||
# process, which may cause wedges in the gate later.
|
||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
|
||||
openstackdocstheme>=1.31.2 # Apache-2.0
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||
sphinxcontrib-apidoc>=0.2.0 # Apache-2.0
|
||||
sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0
|
||||
sphinxcontrib-httpdomain>=1.6.1 # BSD
|
||||
reno>=2.7.0 # Apache-2.0
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
|
|
|
@ -56,9 +56,11 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/panko'
|
||||
bug_project = 'panko'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/panko'
|
||||
openstackdocs_pdf_link = True
|
||||
openstackdocs_auto_name = False
|
||||
openstackdocs_bug_project = 'panko'
|
||||
openstackdocs_bug_tag = ''
|
||||
project = u'Panko'
|
||||
copyright = u'2012-2015, OpenStack Foundation'
|
||||
|
||||
|
@ -92,7 +94,7 @@ exclude_patterns = ['**/#*', '**~', '**/#*#']
|
|||
show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = 'native'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
|
|
@ -52,9 +52,10 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/panko'
|
||||
bug_project = 'panko'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/panko'
|
||||
openstackdocs_auto_name = False
|
||||
openstackdocs_bug_project = 'panko'
|
||||
openstackdocs_bug_tag = ''
|
||||
project = u'Panko Release Notes'
|
||||
copyright = u'2015, Panko Developers'
|
||||
|
||||
|
@ -95,7 +96,7 @@ exclude_patterns = []
|
|||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = 'native'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
|
|
@ -6,20 +6,14 @@ coverage>=3.6 # Apache-2.0
|
|||
elasticsearch>=1.3.0 # Apache-2.0
|
||||
fixtures<2.0,>=1.3.1 # Apache-2.0/BSD
|
||||
PyMySQL>=0.6.2 # MIT License
|
||||
# Docs Requirements
|
||||
oslotest>=1.10.0 # Apache-2.0
|
||||
psycopg2>=2.5 # LGPL/ZPL
|
||||
pymongo!=3.1,>=3.0.2 # Apache-2.0
|
||||
python-subunit>=0.0.18 # Apache-2.0/BSD
|
||||
sphinx>=1.6.2 # BSD
|
||||
openstackdocstheme>=1.11.0 # Apache-2.0
|
||||
sphinxcontrib-httpdomain # BSD
|
||||
sphinxcontrib-pecanwsme>=0.8 # Apache-2.0
|
||||
stestr>=2.0.0 # Apache-2.0
|
||||
testtools>=1.4.0 # MIT
|
||||
gabbi>=1.11.0 # Apache-2.0
|
||||
os-testr>=0.4.1 # Apache-2.0
|
||||
WebTest>=2.0 # MIT
|
||||
pifpaf>=0.0.11
|
||||
reno
|
||||
sqlalchemy-utils
|
||||
|
|
Loading…
Reference in New Issue