Commit Graph

9 Commits

Author SHA1 Message Date
pengyuesheng
835081ac36 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: I2809c6be60ac102b40c942483a6cdbc0d113117f
2019-07-31 16:42:51 +08:00
Eric Fried
289130fc3d Bump openstackdocstheme to 1.30.0
...to pick up many improvements, including the return of table borders.

Change-Id: Ic3a43e2e35f361234f081c0e1f34729cf6560828
2019-05-30 18:08:16 -05:00
Qiu Fossen
43c859b421 Cap sphinx for py2 to match global requirements
Change-Id: I7d95fedf44dd0504a57ffa4c4ecd54fccf7a0230
2019-05-17 05:06:10 -04:00
Chris Dent
2588c7b8da Update docs bug links to storyboard
Update doc, api-ref and releasenotes conf.py to set 'use_storyboard' to
True. According to the docs of the theme [1] bug project and tag are
not used when using StoryBoard.

doc/requirements.txt (used by all the docs-related jobs) is updated
to make openstackdocstheme>=1.24.0. That version is the most recent
one to have bug fixes related to use_storyboard.

[1] https://docs.openstack.org/openstackdocstheme/latest/#using-the-theme

Change-Id: I3b28dd1da9e8e75eda151a3025e78a5a47c971f9
Story: 2005190
Task: 29948
2019-03-11 20:54:24 +00:00
Mike Perez
72ce7c738c 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: If5c0bf2b0dcd7dbb7d316139ecb62a936fd15439
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
2018-07-16 15:04:00 +01:00
Matt Riedemann
47176e9f08 Add osprofiler config options to generated reference
osprofiler is optional, but if it's installed we'll
load up the configuration options from the library,
but they weren't in the generated config sample so
people would have to find the osprofiler docs, or
worse the code, to figure out how to configure it.

This simply adds the osprofiler config options to the
nova config sample, which will also show up in the
config reference docs.

Change-Id: I28d35165ed77487cd49d560fb1eda4f1d640734e
Closes-Bug: #1774208
2018-06-16 12:46:19 +00:00
Stephen Finucane
2925105d0f doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-05-03 14:34:47 +01:00
OpenStack Proposal Bot
7366b2c64e Updated from global requirements
Change-Id: I3d8b3d783c2ab37e1c907f7e6802ac00152d8439
2018-03-17 08:48:15 +00:00
Stephen Finucane
7b01024591 Follow the new PTI for document build
The Project Testing Interface [1] asks that we list requirements in
'doc/requirements.txt' and build docs by calling 'sphinx-build' directly
instead of via the 'build_sphinx' setuptool/distutils wrapper. Start
doing this.

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

Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 14:39:36 +00:00