Commit Graph

10 Commits

Author SHA1 Message Date
songwenping 3778b1a608 Remove unnecessary unicode prefixes
Change-Id: Ic62cdbfb3f40ecaa2f20345951c8c34e20e6fd23
2022-04-19 16:01:38 +08:00
Andreas Jaeger 364f85e71d 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: Iab669aaf569600fa87da8404663bbbbde0be14d6
2020-05-28 14:36:07 +02:00
Andreas Jaeger b91da1c60f Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Update requirements, no need for python_version anymore
- Use newer openstackdocstheme version
- Use hacking 3.0

Change-Id: Idefb3435a6b2b0765781fb6458c2def5a5e38a1d
2020-04-12 18:55:00 +02:00
pengyuesheng aaccfd9ce8 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I37a1af868c189c30cc9aa9ee4ca78786ad82d547
2019-10-12 15:14:06 +08:00
Zuul fcd1be5427 Merge "Build pdf docs" 2019-09-24 15:02:24 +00:00
Chris Dent 65b74ff0f8 Build pdf docs
This follows the instructions [1] in an attempt to build pdf docs.

This creates workable results, but there is room for improvement.

[1] https://etherpad.openstack.org/p/train-pdf-support-goal

Change-Id: Icf7c22bf9d1de6fb2a74a756c370930d4c00b0b9
Story: 2006110
Task: 35395
2019-09-11 13:25:41 +00:00
Chris Dent 040e9c199d Update bug link in docs to point to storyboard
It had been nova, but we're past that now.

Change-Id: Ief1321f9ca7b03fd679cfdb567c2634389c26b43
2019-09-11 13:51:32 +01:00
pengyuesheng 8866073511 Sync Sphinx requirement
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.

Change-Id: I7410ad173a84b30562a1cdad743553dbd432f729
2019-08-02 10:58:53 +08:00
Chris Dent 1ae04e7d41 Tune up documentation to be more useful
The cookiecutter template includes more documentation than we
need, so remove lots of extraneous stuff and lay in the basics.

Change-Id: I6ed22f70153b00844e8de05d186ecc780debc48c
2018-12-13 12:26:43 +00:00
Chris Dent 373e6d16d1 Initial Cookiecutter Commit. 2018-09-14 14:28:48 -06:00