11 Commits

Author SHA1 Message Date
Mark Goddard
354113c20b docs: Move configuration reference to subpath
This allows us to add configuration scenarios.

Change-Id: Id636f78c61237fb27fa65fa3d4b3fc1a4cf0ba6a
Story: 2004360
Task: 40777
2020-08-28 08:28:40 +01:00
Andreas Jaeger
87c91cc615 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.

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: Ic10edb7103455b477cece3940f150f4345611562
2020-06-11 17:22:05 +00:00
Ghanshyam Mann
208c46e72c [ussuri][goal] More cleanup for python 2.7 drop
Cleanup requirement and set ignore_basepython_conflict = True
in tox to avoid python version conflict warning which going
to be error in future.

Change-Id: Ia4ce42a20417d69efd50ef563aabd8cffbb7b346
2020-02-29 15:23:18 -06:00
Ghanshyam Mann
c0a1216afa [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

kayobe is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: Idbbdd96ff23846d29833c5997d1e32e65b5169f2
2020-02-11 10:12:39 +00:00
gujin
d23ed92588 tox: Keeping going with docs
1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

2. Cleanup the folders before run commands

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: Ib3133820a3d3ca3027ea2f9bc9b6907929cff8ed
2019-11-11 13:49:54 +00:00
Mark Goddard
798b7dfc53 Build pdf doc
The is one of community goals that each project should produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is
recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: Ib8a238f5ad4329527147be72331b87f57877f68e
2019-10-16 14:36:13 +01:00
pengyuesheng
c620dd84f7 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: Ia2c3c6f3d38474465fc012bc4b798a5da0d3aadb
2019-10-09 16:25:25 +08:00
Mark Goddard
c44f27b4ae Move to openstackdocstheme for docs & release notes
Sphinx configuration adapted from kolla ansible.

Change-Id: Ibcfbd9114a099d8b487f543d526b0cde0744d84a
2019-08-03 19:02:20 +01:00
jacky06
67a4d50288 Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest
3. Remove unncessary "=="

Change-Id: Idcb616fd3add4d58f22b91865cec8a54fe492092
2019-06-25 02:24:45 +00:00
Mark Goddard
1c376f071e Build release notes using reno
The current approach of adding release notes to a single file means that
we end up with merge conflicts every time a change is merged. This is
wasteful of time and resources.

Change-Id: I19f956e4e3991e39252eaa3a1b97a3b2812858d2
Story: 2001637
Task: 6649
2018-05-04 15:11:23 +01:00
Mark Goddard
dbc1f26848 Follow the new PTI for document build
For compliance with the Project Testing Interface [1] as described in
[2].

[1]
https://governance.openstack.org/tc/reference/project-testing-interface.html
[2]
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I03d36b2545f69c4ca3ca1ced73d179e81b7b8811
2018-04-03 17:28:15 +01:00