Commit Graph

18 Commits

Author SHA1 Message Date
Andreas Jaeger 7820cafffe 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
* parallelizing building of documents

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_name to use project as name.
Set openstackdocs_pdf_link to link to PDF file.

Remove docs requirements from lower-constraints, they are not installed.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I320a69816b4101bb76b88448881f3177c892ea92
2020-05-21 13:43:22 +00:00
Vishakha Agarwal 6dbf3a68b4 Cleanup doc/requirements.txt
Change-Id: Icb0b7cbcb830a55910942b36a111562b83554f3d
2020-01-14 13:00:46 +05:30
Vishakha Agarwal 90f6ff727a Remove python 2.7 specific library
Change-Id: I3bdf95846955dbf95ba8e85347f08638b1acf80e
2019-12-17 08:18:43 +00:00
Zuul 3e5bc0cbbc Merge "Blacklist sphinx 2.1.0 (autodoc bug)" 2019-07-19 19:33:07 +00:00
Zuul a63c9945e5 Merge "Update unified limit documentation" 2019-07-17 07:53:08 +00:00
pengyuesheng fb4306c354 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details
Depend-On: https://review.opendev.org/#/c/663060/

Change-Id: Idf5c5bd423dca5c1e6e0927edf41f7565e505039
2019-07-02 11:20:12 +08:00
翟小君 6fef498ff3 Bump openstackdocstheme to 1.20.0
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: Icca6ef602af26a1d10766fd416011cdcceaa00a1
2019-07-01 23:48:56 +08:00
Lance Bragstad c49a64dd9a Update unified limit documentation
- Fix minor grammatical issues
- Include the `strict_two_level` model in the enforcement model
  section
- Improve readability
- Add enforcement examples in the form of diagrams

Change-Id: I483bf172dfe01f1db5a9673192eac988267996da
2019-06-17 13:24:20 +00:00
zhangboye c04d0f5f54 Cap sphinx for py2 to match global requirements
Change-Id: Id29eb9d0da74ffcc970e16f6fef29fb9f37c3e1a
2019-05-16 11:40:59 +08:00
Mike Perez 9575937e56 Replace support matrix ext with common library
The code to generate a support matrix has been pulled into a common
library. Using this instead of duplicating code in various projects that
need it.

Change-Id: Ib15c086ceb84029e96be0fc60bd64f2a7a3e41aa
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
2019-04-16 18:09:14 -07:00
Colleen Murphy 4a141fea51 Add introduction section to federation docs
Add an introduction to the federation documentation discussing
background information on identity federation and how it is implemented
in keystone.

This repurposes some of the content in this blog post[1] of which I am
the author.

[1] http://www.gazlene.net/demystifying-keystone-federation.html

Partial-bug: #1793374

Change-Id: I5f3a5e70c7b868762880930ea6277691f44c046a
2018-12-11 15:37:06 +01:00
Dirk Mueller 0fa6f97891 Switch to python-ldap
pyldap is deprecated and merged with python-ldap, so we should depend
on it directly instead of the deprecated wrapper. For details see
https://pypi.org/project/pyldap/

Change-Id: I2c8ee2c792a476fe12c234a55af24144e6b511cd
Depends-On: https://review.openstack.org/#/c/582973/
2018-07-16 17:33:38 +02:00
wangxiyuan 488ecef329 Fix warnings in documentation
A recent change defaults the warning-as-error to True:

  https://review.openstack.org/#/c/559348/

Which is causing our documentation jobs to fail locally and in the
gate/check queues.

This commit fixes both issues that are causing failures so that
we can get the doc jobs passing again.

Closes-Bug: 1774508
Change-Id: Ic1eff48a6f40aa315cc5e566a0f9e930a20b9837
2018-05-31 21:28:41 +00:00
Nguyen Hai a04a1dc782 Follow the new PTI for document build
- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc

REF:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Depends-On: https://review.openstack.org/#/c/559334/
Change-Id: I1d5f01cf49f36567f5a891c69c7269d3e966b9c5
2018-04-09 01:13:58 +09:00
OpenStack Proposal Bot c16ed74402 Updated from global requirements
Change-Id: I196d41ddf16805197072a2182febfa4adef19f2d
2018-03-15 07:02:56 +00:00
OpenStack Proposal Bot 7070215c0a Updated from global requirements
Change-Id: I30fa0a8644684bdcdf121a9ee9d2f193ba736d33
2018-01-24 00:56:57 +00:00
OpenStack Proposal Bot ad6a2bce2a Updated from global requirements
Change-Id: I399e08cbd0d5fa519bd0a1995d61cbda340f34bb
2018-01-17 20:36:58 +00:00
qinglin.cheng 07bba320ae Create doc/requirements.txt
For compliance with the Project Testing Interface as described in:

https://governance.openstack.org/tc/reference/project-testing-interface.html

Refer to:

http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: Ic05a55fb14741bb0802c217c81b0035b6e1f7de2
2017-12-19 16:17:26 +01:00