Commit Graph

14 Commits

Author SHA1 Message Date
Nguyen Hai 36739ca41b Follow the new PTI for document build
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

Change-Id: Icc65afd5f6c0e22147b179c16d6a4fa5f47954ce
2018-05-31 06:24:42 +00:00
Takashi NATSUME f49397be06 Uncap sphinx version
Sphinx version has been capped since
I9c45d239e156ec4fb49b5d8bd2404b66155be92b
in order to fix an issue with resolving citations.

Then, in I7e55dcf910e0ba6dd85b565db8cb1ecbdd39634a,
the issue has been fixed by modifying citation references.

So uncap sphinx version.
But sphinx 1.6.1 has another issue (*1),
so leave sphinx 1.6.1 in the blacklist.

*1: https://github.com/sphinx-doc/sphinx/issues/3754

Change-Id: I09acc562bc37edc3c8a40027f7eb359aaa956c32
Related-Bug: #1695127
2017-06-06 07:35:54 +09:00
Matt Riedemann 0069865e2c Cap sphinx<1.6.1
1.6.1+ has an issue with resolving citations so we need
to cap it for now.

Change-Id: I9c45d239e156ec4fb49b5d8bd2404b66155be92b
2017-06-02 16:38:36 -04:00
Matt Riedemann 820f5a91cc Blacklist sphinx 1.6.1
For some reason this release makes docs builds fail because it
can't resolve citations. The version in upper-constraints, which
we don't use in this repo, is 1.5.6, so blacklisting 1.6.1 seems
fine.

Change-Id: I2b73370876c80a88bd4a48db7fdd6ac23ace4503
Closes-Bug: #1693010
2017-05-23 15:34:17 -04:00
Matt Riedemann c3e9e7f56b Blacklist yasfb 0.6.0
The 0.6.0 release broke on non-ascii characters in the specs,
but it's fixed in 0.6.1, so just blacklist 0.6.0.

Change-Id: I03226ecaa5016f50d89d8ce31c39379f247863a9
2017-04-13 18:06:03 -04:00
Matt Riedemann 4872a861f2 Cap yasfb at 0.6.0
Something in 0.6.0 is making docs builds fail because
of non-ascii character parsing. We need to fix those
long-term and uncap this, but let's do it some day when
it's not spec freeze.

Change-Id: I7968790dc5197204de5ce7e38508a866801aef27
2017-04-13 16:38:08 -04:00
Stephen Finucane 0a4c1bcaeb Mitigate 'no "man_pages" config value' error
For some reason, the gate was failing with the following message:

    "WARNING: no "man_pages" config value found; no manual pages will be
    written"

I don't know why this has suddenly started happening, but it was
mitigated by 'I97d4ade4'. However, this change didn't fix the root cause
of the issue, which is that 'pbr' defaults to building both html and man
page output and we don't need/want the latter.

Disable the man page builder entirely. This allows us to remove all man
page-related configuration in the process, seeing as it'll never be
used.

Change-Id: I83bb54f413cbad29afb2233043150fb037bca3bd
2017-04-12 10:13:48 +01:00
Matt Riedemann ad4c1c5fe7 Update requirements to fix pbr 2.0.0 fail
nova-specs doesn't sync requirements updates from the
global requirements repo and doesn't have the correct
requiremnts ranges for hacking which is pulling in
pbr 2.0.0 which breaks with warnerrors=True (since that
was removed in 2.0.0).

This syncs up the requirements with the latest from
the requirements repo and updates the hacking versions.

Change-Id: I8db1038693c5047ebffd0065055efc5ea211b106
Related-Bug: #1668848
2017-03-01 17:24:44 -05:00
Ghanshyam 763a287fab pbr > 1.6 to avoid pip 8 distutils issue
"Detected a distutils installed project" issue is hitting
for argparse for specs repo.
In case of nova specs repo it comes from testtools.

As a workaround, making pbr version > 1.0 so that venv having pip
< 8 and works fine. pbr < 1.0 endup with pip 8 and fails.

pbr < 1.0 has pip explicitly in requirement.txt and trigger
to update the pip to 8.

pbr > 1.0 does not have the requirement.txt thing and does not
trigger pip updates for venv.

This is issue with all specs repo having distutils installed projects
because g-r requirement update does not sync the specs repo requirements.
But that is another thing can be fixed if there is no reason of not
updating specs requirements.

Change-Id: I31a1353d161e5e5687332cd8300ba5dd4f992a67
2016-01-21 15:27:28 +09:00
Jenkins 0ed11e5bfe Merge "Remove docutils pin" 2014-10-13 21:07:54 +00:00
Doug Hellmann 8c0a70ec54 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:35 -04:00
Andreas Jaeger 1f4c607453 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:59:35 +02:00
Joe Gordon 037adec4b8 Add unit test to make sure all sections are present
Add a unit test that will check to make sure all top-level headings
and sub-headings are present.

The downside of this test is that it's going to fail on *every* merged
spec if we add or change a heading to the template.

Co-authored-by: Russell Bryant <rbryant@redhat.com>
Change-Id: I1c15282e166fb3fe2e60fcf063a6cd822a3411ff
2014-03-31 12:03:41 -04:00
Russell Bryant 7e2f8f8e92 Make nova-specs an oslosphinx project
Update the nova-specs project to use sphinx.  This will allow us to
still write our specs using rst, but also have a nice framework for
rendering and publishing the specs if we choose to.

Change-Id: Ib92231acb28bba44abafb7dd554404f542da13a7
2014-03-24 16:28:41 -04:00