Commit Graph

13 Commits

Author SHA1 Message Date
Slawek Kaplonski c886130f15 Switch to stestr
According to Openstack summit session [1] stestr is
maintained project to which all Openstack projects
should migrate.
Let's switch it then.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: Idd7629f2a051aadaf53b04a1b331b20d7fa690de
2018-06-22 12:50:11 +02:00
ZhaoBo c95726bbf0 Need to follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

To handle this, this commit changes:

- Introduce doc/requirements.txt
- Update tox.ini [docs] target for developer convenience
- Fixes a lot of warnings caused by a newer sphinx 1.6.5 because
  sphinx specified in upper-constraints.txt is used in the new PTI.
- Drop unnecessary [pbrp] warnerrors in favor of warning-is-error.

Change-Id: If40305044c9dfe0024b64bd3921232bb0a6c9372
2018-02-28 23:58:22 +09:00
Igor Duarte Cardoso 73ca11b148 Fix docs by limiting sphinx requirement to <1.6.1
The gate pulls the latest sphinx package, 1.6.2 at the moment,
which, just like the ignored version 1.6.1, seems to break
the docs environment.

This patch thus limits sphinx to <1.6.1 instead of simply !=1.6.1.

Related-Bug: #1693010
Change-Id: I30f2ac347d0a02ba9cac3665404c94582f6e0385
2017-06-01 11:16:35 +00:00
Armando Migliaccio 7b8dd5c2bf Document how this list be kept in sync
Change-Id: I597255249cb00b419f835cee54758d625d1d7d3e
2017-05-19 12:38:17 -07:00
Armando Migliaccio 0224f62622 Sync down exclusion version for sphinx
Change-Id: If5e4e1ce23fb1bde4aafbbf2a4ee295102a67bc3
2017-05-18 16:41:18 -07:00
Boden R 22b8477ac8 Fix doc build
pbr 2.1.0 has a regression that it always tries to build 'man'
and this causes 'WARNING: "table cell spanning" not supported'.
We specify warning-is-error = 1 and as a result all documentation build
now fails.

This can be fixed by excluding pbr 2.1.0 in requirements.txt.
Note that pbr 2.1.0 is already marked as blacklist in global-requirements.txt.

'man_pages' config option is also dropped from doc/source/conf.py
as we are not interested in manpages as output at all.

Related-Bug: #1681983

Change-Id: Id9aa7b128ad8d4af5db6b96a758f1134a774db1b
2017-04-15 00:12:04 +00:00
Akihiro Motoki 095580ec46 Update sphinx to 1.5
Most projects now use sphinx 1.5.
sphinx 1.5 provides some new directives which are possibly useful.

sphinx 1.5 is a useful feature which considers warnings as error.
It prevents sphinx warnings into documents.
Also fixes existing sphinx warning.

At the same time, requirements.txt is synced with global-requirements.

Change-Id: I3b4a18a2483fa6966d8d4ac78dcb8ceac0524cf7
2017-03-31 00:20:56 +00:00
Jenkins e946c35fb8 Merge "Remove docutils pin" 2014-09-25 19:22:49 +00:00
Doug Hellmann d779a98718 Add RSS feed
Publish an RSS feed of the changes to the specs repository to make the
specs more discoverable.

Change-Id: Ib4f84efab8b3af3ddd47d38d63a91362612bd655
2014-09-10 16:01:10 -04:00
Andreas Jaeger 5151709ef2 Remove docutils pin
This was added to work around bug 1091333.  A new sphinx has been
released and so this is no longer necessary.

Change-Id: I9107884d964757a9154bdd1feb4ea6df4e9df43e
2014-08-27 11:58:54 +02:00
Longgeek 1d58235d8b Update pbr version
Change-Id: Id4ee12ae94d9a0ceee63286ad4e99e01d1223398
2014-06-29 00:14:57 +08:00
Nachi Ueno 9ae6b365f3 Added Sphinx diagram tools
Added some tools and example
- blockdiag for block diagram
- nwdiag for network diagram
- actdiag for act diagram
- seqdiag for sequence diagram

Change-Id: Idc709dca40f756a66beca5ab5da2a377b04338d2
2014-04-17 21:11:15 +00:00
Kyle Mestery 4f354e9fd2 Add base neutron-specs framework
Build the base framework for the neutron-specs repository. This was taken
from the nova-specs repository and has been slightly tweaked for neutron.

Change-Id: I1f3ce2f1992491e1420a2f35e97a06b6b604f9e0
2014-04-14 03:08:02 +00:00