Commit Graph

1237 Commits

Author SHA1 Message Date
Tony Breeds 6cd93616d3 Retire Packaging Deb project repos
This commit is part of a series to retire the Packaging Deb
project. Step 2 is to remove all content from the project
repos, replacing it with a README notification where to find
ongoing work, and how to recover the repo if needed at some
future point (as in
https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project).

Change-Id: Id5c758d0c81166d0f591d95d335d5bfefd77fc5e
2017-09-12 15:45:33 -06:00
Andreas Jaeger c3bf1aa507 Switch to openstackdocstheme
Update to use current openstackdocstheme everywhere instead of
oslosphinx, remove now obsolete settings.

Change-Id: I812f72ebf9fb4d96b1031880c44596833da9d384
2017-06-27 22:59:01 +02:00
OpenStack Proposal Bot 58eeb19133 Updated from global requirements
Change-Id: I4a89feb028462f0d3d79528d3827c1b085a157f4
2017-06-27 12:19:18 +00:00
Jenkins 8fcf7a6e7a Merge "Updated from global requirements" 2017-06-21 06:04:47 +00:00
Andreas Jaeger 3c27d9fd88 Add openssl libs to bindep
Those are not installed anymore by default and are needed to fix builds
of python modules.

Change-Id: I38a1f0ff1ce5a776ee981c200d5b55d6753d260b
2017-06-18 10:58:56 +02:00
OpenStack Proposal Bot d6eeb8e50b Updated from global requirements
Change-Id: I59b8adc143e016afddbbad2daa61f3a3b2c79e35
2017-06-16 12:19:30 +00:00
OpenStack Proposal Bot 2df1a73033 Updated from global requirements
Change-Id: I4fb63c1b6a7f8d671f2e5c47216ebb2cfbedea20
2017-06-05 12:49:40 +00:00
Jenkins 4c519c3376 Merge "Add bindep.txt" 2017-06-02 05:10:26 +00:00
Jenkins f66660ab5a Merge "[diff_branches] remove the broken --format option" 2017-06-02 05:03:13 +00:00
OpenStack Proposal Bot 380b53c6bb Updated from global requirements
Change-Id: Ic1261c6cf954158dd5a89ba8f3515f4ac5cb0902
2017-06-02 02:34:12 +00:00
Gauvain Pocentek b5742da44a [diff_branches] remove the broken --format option
It doesn't work as expected ('r', 's', or 't' instead of 'rst') and we
only provide one option anyway.

Change-Id: I4300264d7f919fb2041b10ee5d9f6e246c443377
2017-06-01 22:37:37 +02:00
Andreas Jaeger 14623e787b Add bindep.txt
Add bindep.txt file with packages needed to use the repository.

Change-Id: I409d33c60a2be1886918b7e1ed8e4c6f3ca346c2
2017-05-25 17:32:40 +02:00
OpenStack Proposal Bot e136fd3a56 Updated from global requirements
Change-Id: I78a34629457a279285d39e632472d3dd992223d7
2017-05-17 03:55:52 +00:00
Andreas Jaeger 5a6b8676b0 Add release-note about docs
We will publish the next release at docs.openstack.org, add this to
release note entry.

Change-Id: Ibfaf009449eb587768427f1a1d7196ed69dee8d8
2017-05-01 17:25:12 +02:00
Jenkins 5d20c21aee Merge "[autohelp] Update opt types" 2017-05-01 12:15:43 +00:00
Jenkins fe52ed757f Merge "Update RELEASE_NOTES" 2017-05-01 12:14:53 +00:00
Jenkins 88514f2f1c Merge "Update docs theme configuration" 2017-05-01 12:14:48 +00:00
Andreas Jaeger 00ed2ea161 Update index page
Remove entries that have no content, rename indices section to search
since that is the remaining entry.

Change-Id: I167caa2cc0e99d370ca3ea10edd96fe1ba482d54
2017-05-01 10:16:47 +02:00
Andreas Jaeger 0e526705c6 Update RELEASE_NOTES
Add link to current release notes, use https and fix a layout problem.

Add two new subsections so that not all releases show up in the table of
content and clutter it.

Change-Id: I56444568a671b2bf6c052bc2a17f129c5dcf43e3
2017-05-01 10:13:41 +02:00
Andreas Jaeger ea1ae95b63 Update docs theme configuration
Enable log-a-bug feature and add information on when document was built.

Disable pep8 check for doc/source/conf.py.

Change-Id: Ia86791ac69845572b2fbc536732afcf901bcf203
2017-04-30 09:30:39 +02:00
Brian Moss d3bc42483a Update sitemap tests
- add py3 to tox.ini (gate already tests py3)
- move all tests to $GITROOT/test so they can all run
  through testr
- add scrapy to test-requirements.txt to support sitemap tests
- move tests from test_items.py to test_sitemap_file.py
- fix broken sitemap tests
- add newton to list of old releases in sitemap_file.py
- ignore flake8 H101 as it returns false positives for Sphinx conf.py
- Use openstackdocstheme for docs
- Update sitemap README
- Restructure repo docs
- fix minor style issues

Change-Id: I22c018149b2eefde6ca5c38c22ac06886fe9a7a8
2017-04-29 10:36:27 +10:00
Gauvain Pocentek 4534f04bad [autohelp] Update opt types
Copy/paste (mostly) the dict from oslo.config.

Change-Id: I16c9e554f29f7dee08768d4a7c02991ad8718f66
2017-04-28 17:53:40 +02:00
Gauvain Pocentek 53de7deb1c [autohelp] Return options as dicts instead of lists
This patch updates the _format_opt method to return a dict instead of a
list. This makes the RST templates easier to read and maintain.

Change-Id: Ia1b494b8ec8ed1e523ebe7198bcba00594e21ac5
2017-04-28 17:48:33 +02:00
Jenkins 121ddfebd1 Merge "Remove swift tooling" 2017-04-20 13:45:44 +00:00
OpenStack Proposal Bot cec1dd297e Updated from global requirements
Change-Id: I648307b10e585f89582fa56768cee164f99b17b6
2017-04-12 04:19:21 +00:00
Stephen Finucane e90895e010 Remove swift tooling
Per the comment on change 'If0cf66aa9', we no longer track swift config
files as part of openstack-manuals. As such, we can remove the special
casing for this project.

Change-Id: I135caa57e1dcdd4114033276d89fc87c28a71aac
2017-04-11 15:54:45 +01:00
Stephen Finucane efdab278fc Actually skip 'update' when flagmapping are disabled
A 'return' was missing, meaning we still built flagmappings.

Change-Id: I01170097e06f2f44152dd0cbd57889f66f9758f4
2017-03-22 16:05:19 +00:00
Stephen Finucane 81f7a8f75a option.help can be None
Handle the case where option.help is none, meaning we can't use
'startswith'.

Change-Id: I0d7dceeed89ad287b9786f04bf8dc9aba1b845dd
2017-03-22 16:05:19 +00:00
Jenkins f9a8579b25 Merge "[cli-ref] add API version for cinder explicitly" 2017-03-22 07:07:45 +00:00
Jenkins 04d9d3b7d1 Merge "Allow overriding of openstack-manuals dir" 2017-03-21 22:37:58 +00:00
Jenkins b398e23e6e Merge "trivial: Remove 'pass_through'" 2017-03-21 22:37:53 +00:00
Jenkins 3a47ece53b Merge "Make flagmapping optional" 2017-03-21 22:37:47 +00:00
Jenkins b7a91f869f Merge "Separate option formatting" 2017-03-21 22:37:03 +00:00
Jenkins cf594c5b1f Merge "Index options by group too" 2017-03-21 22:36:58 +00:00
KATO Tomoyuki 89100368b5 [cli-ref] add API version for cinder explicitly
Python-cinderclient does not use the latest Block Storage API.
As work around, we need to set OS_VOLUME_API_VERSION environment
variable explicitly so that we can generate all commands.

Change-Id: I5de94f1fd5e8a4068cb7209062588eb6ade73fc8
Closes-Bug: #1673425
2017-03-22 00:08:06 +09:00
Jenkins 4b6583d302 Merge "Simplify the format of paragraphs" 2017-03-20 19:15:38 +00:00
Jenkins 1c9722d637 Merge "Include 'deprecation' as a flag" 2017-03-20 17:01:50 +00:00
Jenkins ca669fa378 Merge "Remove unnecessary parameter" 2017-03-20 17:01:36 +00:00
Jenkins f063e5900a Merge "Add missing doc for dump in autohelp-wrapper" 2017-03-14 16:04:50 +00:00
Christian Berendt eb74019d39 Add missing doc for dump in autohelp-wrapper
Change-Id: I3efa253867ddf5696cdc203a98884a9368b82d08
2017-03-14 08:52:54 +00:00
Jenkins 8c6a65a31a Merge "Handle object type when registering runtime options in autohelp" 2017-03-14 02:53:37 +00:00
OpenStack Proposal Bot 883067f191 Updated from global requirements
Change-Id: I0e99cfae0b2a057552105820b443a93f23c197e1
2017-03-13 19:39:12 +00:00
Christian Berendt 9a7a07dde1 Handle object type when registering runtime options in autohelp
Change-Id: I9800c7ae467a807c0e6b6bca6784aace2140c75b
Closes-bug: #1672377
2017-03-13 14:28:15 +01:00
Stephen Finucane 74b981092b Allow overriding of openstack-manuals dir
I already have a (sizable) openstack-manuals repo cloned locally and it
would appear tox does not work in a nested repo. Provide a way to
override this option.

Change-Id: I4ef80825598cc7d98a4046afd5b131484e5a3469
2017-03-10 11:34:20 +00:00
Stephen Finucane b4492e34f9 trivial: Remove 'pass_through'
This doesn't warrant it's own function and makes this a little more
difficult to read.

Change-Id: Ieff01bc97dc54b8ff68bff577803d41b921a1375
2017-03-10 11:34:18 +00:00
Stephen Finucane d962670652 Make flagmapping optional
Support for flagmappings was useful in the days before OptGroup was
available. Today, it's mostly a burden and not necessary for projects
such as nova. Make this feature optional, allowing us to make use of
built-in oslo.config where available.

The actual flagmapping files themselves are found in another project and
cannot be removed here. This will be done in a separate change.

Change-Id: I27296954ad8ce2010fc464ad81c8da4859ba2531
2017-03-10 11:34:12 +00:00
Stephen Finucane 88ae9f08ac Separate option formatting
We're going to add another code path for projects that rely on
oslo.config's 'OptGroup' to group their options. To minimize
duplication, we should drag the option formatting into its own
function.

Change-Id: I755489036758d589240d9c057e6fcb109de68fde
2017-03-10 11:20:28 +00:00
Stephen Finucane d77ab16161 Index options by group too
We will use this in a future change.

Change-Id: I0e0f0b84ee10cf2003d9eae349aee0c4b99cb69c
2017-03-10 11:20:28 +00:00
Stephen Finucane 2860b9df09 Simplify the format of paragraphs
There's a rather complicated bit of code used to split blocks of text
into paragraphs. Replace this with something a little simpler that makes
use of our paragraph-ization rather than trying to rebuild blocks of
text.

Change-Id: I321ba57d0f7090afec34c6207f9a42493b8a3249
2017-03-09 15:20:11 +00:00
Stephen Finucane f0a146d112 Include 'deprecation' as a flag
There is support for displaying deprecation information in a somewhat
structured manner (proper lists, emphasis on titles, etc.). However, the
deprecation information is still included in the help text rather than
in this flags section. This makes things more difficult than they need
to be.

Resolve this by instead including any deprecation information in the
flags section. This will transform output from something like this:

  (String) DEPRECATED: Host to locate redis. Replaced by
  [DEFAULT]/transport_url

to this:

  (String) Host to locate redis.

  Deprecated
    Replaced by [DEFAULT]/transport_url

Which should be a little more obvious.

It's necessary to fix the template, which added the flags at the same
level as the title and description, resulting in varying numbers of
bullet points for the list.

Change-Id: Ifaee90a814fa3efee8b41eb0411535cff70e7309
2017-03-09 15:19:53 +00:00