Commit Graph

25 Commits

Author SHA1 Message Date
Andreas Jaeger 9704c344c1 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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.

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

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

Change-Id: I853c21c0789296164632c47a0b3534321cec01ee
2020-05-30 17:08:47 +02:00
Ghanshyam Mann 74ab95431c [ussuri][goal] Drop python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

specs repo either has py27 job or requirement or tox env.

Doc building still use deprcated oslosphinx and incompatible
version of yasfb which lead to error-

sphinx.errors.ExtensionError: Could not import extension yasfb (exception: cannot import name 'logging')

This commit replace oslosphinx with openstackdocstheme ti fix the error.

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: I76a9e0e3259ec52564f31a239079cd91da897ee9
2019-12-17 18:41:24 +00:00
ricolin d90acffe4e Add Rocky Spec Template
Change-Id: Ie28ba2087c6d87aec57198afe9c328542a4c25ca
2018-06-28 13:41:33 +08:00
Jenkins af61ddc492 Merge "Remove link to modindex" 2017-09-14 22:38:32 +00:00
ricolin ff62ba1f22 Add Queens directory
Change-Id: Ic8def26ae961e9d0c5bf511636597998c44558b2
2017-08-22 16:56:33 +08:00
Peter Razumovsky 2d85ca9721 Move to backlog properties group spec
Currently properties group spec is already merged, but
still is not implemented, so need to move it to backlog due
to small community's interest.

implements bp heat-property-group

Co-Authored-by: Kanagaraj Manickam <mkr1481@gmail.com>

Change-Id: Id4847f79e6a9ad4b9dc3be2459604dd9583cb36e
2017-03-20 18:10:20 +04:00
aditi d31fe29493 Remove link to modindex
The documentation build does not generate any module index, thus
remove the link to the page. The page
https://specs.openstack.org/openstack/heat-specs/py-modindex.html
does not exists

Change-Id: I5425cccafe833139116d7561bbc70ea015048dd9
2017-01-27 12:10:46 +05:30
Zane Bitter 3cd6c3e0c9 Add Pike directory
Change-Id: I1e867009659da5132fbb0fbed0eefa9f2435ee56
2017-01-23 16:14:15 -05:00
Lars Kellogg-Stedman 912ae3086a create ocata spec template and directory
Change-Id: Id28f0ee290dbc74591e0a1b0228ac36d29b06a1b
2016-08-26 16:02:16 -04:00
Rabi Mishra 48eade3e56 Update README.rst
Updates README.rst and removes the not so
useful contributing.rst.

Change-Id: Icc672e0cb678cb51eff4591daef0401a052e00e7
2016-07-25 05:33:46 +00:00
xiaolihope 22ac3a5f06 Add new directory for newton release
This change added new directory for newton release.

Change-Id: I44bea1b810c75de5d4ad228893e8a2523b0fd22e
2016-03-30 08:07:25 -04:00
Sergey Kraynev 53c1092943 Move all base templates to separate directory
Now we can store all base templates in separate directory and use a link
on these templates instead of copy-pasting it in all new directory.

Change-Id: Ibc0c77642bb40303606047a54e3e198e7ef5a962
2015-12-22 10:19:16 -05:00
Jay Dobies 675043ddbb Further reduced the index toctree depth
The index was still pretty unwieldy. Each spec itself offers a sidebar
with links to the specific sections, so reducing the maxdepth to 1
doesn't make navigation much more difficult. The benefit is a much
easier to skim through list of specs.

Change-Id: I27a68c32392ec05e683bf093304ed41dce6f19f2
2015-10-07 10:12:43 -04:00
Jay Dobies f5340e3b6f Organized specs by release
The spec index page was getting very long with both the toctree depth
and no differentiation between releases. This change adds simple section
headers to separate the spec lists by release and decreases the depth of
the toc (very few third level sections offered any useful information).

Change-Id: I1c0aedc31010be825e4ad0b18540475f77b723db
2015-10-06 14:05:16 -04:00
Peter Razumovsky ddba74ffea Improve Resources' classes docstrings
Current resources' description is poor, so
need to write docstrings for resources with no
description and expand existing docstring, if it's
needed.

implements bp docstring-improvements

Change-Id: I3de1569904aaed4af4a7e7776b8c487db8736b0c
2015-09-09 13:53:53 +03:00
ishant c95449a773 Add type field in Attributes Schema
The changes will add 'type' field in the attributes schema of
each resource plugin.

Specification blueprint add-type-in-attributes-schema

Change-Id: I581242df7bd5cb992372e25abc0746a5255ec55a
2015-03-24 04:28:32 -07:00
Jeremy Stanley e6a969a391 Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I4f6ea6181ac4874fdbfb86dba4daa876ff814d94
2014-12-05 03:30:36 +00:00
Adrien Vergé 86c2c54340 Support Cinder API version 2
This specification proposes to add support for the second version of the
Cinder API, which brings useful improvements and will soon replace
version one.

Change-Id: I91d283b58c1e66b02426f87e22435f149b6b8afb
2014-09-29 22:13:54 +02:00
huangtianhua f5f88cf419 Add a file folder 'juno' for juno bp-specs
Create 'juno' file folder and put the specs into it.
Change-Id: Ica51815dd579c4ddc349e4c9b619c1d7468f2357
2014-09-23 01:29:40 +00:00
Doug Hellmann f4418844ec Use the current date for the copyright statement
Change-Id: I6f7a16a74659c6079abe6200bab6971cc5d6a928
2014-09-10 15:59:54 -04:00
Doug Hellmann ebc8a66194 Remove templates from toctrees
We don't want the templates to show up in the RSS feed, so exclude them
from being converted to HTML and listed in the toctree.

Change-Id: I8e72a938e007b891720138eb127268a5f950872c
2014-09-10 15:59:54 -04:00
Doug Hellmann 594ebed89d 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 15:59:53 -04:00
Andreas Jaeger 320aead742 Fix publishing URL
heat-specs will be published now on specs.openstack.org, correct
the URL.

implements bp publish-specs

Change-Id: Ia25512738284dadfef3a362c2e562119b71453ac
2014-08-02 18:56:30 +02:00
Christian Berendt 0d77b89875 cleaning up index.rst file
Removed notes about the generation of the file and fixed the syntax.

Change-Id: I43b14602a36857de3fd278eaf8bdcf0f6c447587
2014-05-29 12:29:23 +02:00
Monty Taylor 199101dec8 Added cookiecutter specs framework
Change-Id: Ie4bd91b46319531092fb45172648c6f2d767f4d3
2014-05-27 12:47:57 -07:00