Merge "Reorganize docs to fit openstackdocstheme"
This commit is contained in:
commit
d06a992d18
|
@ -63,7 +63,7 @@ source_suffix = '.rst'
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'Neutron Specs'
|
project = u'Neutron Specifications'
|
||||||
copyright = u'%s, OpenStack Neutron Team' % datetime.date.today().year
|
copyright = u'%s, OpenStack Neutron Team' % datetime.date.today().year
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
|
|
@ -4,147 +4,40 @@
|
||||||
Neutron Project Specifications
|
Neutron Project Specifications
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
Rocky
|
Specifications and RFEs
|
||||||
=====
|
=======================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
specs/rocky/index
|
||||||
|
specs/queens/index
|
||||||
|
specs/pike/index
|
||||||
|
specs/ocata/index
|
||||||
|
specs/newton/index
|
||||||
|
specs/mitaka/index
|
||||||
|
specs/liberty/index
|
||||||
|
specs/kilo/index
|
||||||
|
specs/juno/index
|
||||||
|
|
||||||
|
Backlogs
|
||||||
|
========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
|
|
||||||
specs/rocky/*
|
specs/backlog/index
|
||||||
|
|
||||||
Queens
|
Stadium Health
|
||||||
======
|
==============
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
|
|
||||||
specs/queens/*
|
specs/stadium/index
|
||||||
|
|
||||||
Pike
|
.. rubric:: Indices and tables
|
||||||
====
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/pike/*
|
|
||||||
|
|
||||||
Ocata
|
|
||||||
=====
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
Postmortem documentation <specs/ocata/postmortem/postmortem>
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
Newton
|
|
||||||
======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
Postmortem documentation <specs/newton/postmortem/postmortem>
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/newton/*
|
|
||||||
|
|
||||||
Mitaka
|
|
||||||
======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
Postmortem documentation <specs/mitaka/postmortem/postmortem>
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/mitaka/*
|
|
||||||
|
|
||||||
Liberty
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/liberty/*
|
|
||||||
|
|
||||||
Kilo
|
|
||||||
====
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/kilo/*
|
|
||||||
|
|
||||||
Juno
|
|
||||||
====
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/juno/*
|
|
||||||
|
|
||||||
Backlog
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/backlog/**
|
|
||||||
|
|
||||||
Stadium
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/stadium/*
|
|
||||||
|
|
||||||
Queens
|
|
||||||
------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/stadium/queens/*
|
|
||||||
|
|
||||||
Pike
|
|
||||||
----
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/stadium/pike/*
|
|
||||||
|
|
||||||
Ocata
|
|
||||||
-----
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/stadium/ocata/*
|
|
||||||
|
|
||||||
==================
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
=======
|
||||||
|
Backlog
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
**
|
|
@ -0,0 +1,9 @@
|
||||||
|
====
|
||||||
|
Juno
|
||||||
|
====
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -0,0 +1,9 @@
|
||||||
|
====
|
||||||
|
Kilo
|
||||||
|
====
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -0,0 +1,9 @@
|
||||||
|
=======
|
||||||
|
Liberty
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -0,0 +1,14 @@
|
||||||
|
======
|
||||||
|
Mitaka
|
||||||
|
======
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
[Postmortem] <postmortem/postmortem>
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -4,8 +4,8 @@
|
||||||
|
|
||||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||||
|
|
||||||
Postmortem documentation
|
Mitaka Postmortem documentation
|
||||||
========================
|
===============================
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,14 @@
|
||||||
|
======
|
||||||
|
Newton
|
||||||
|
======
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
[Postmortem] <postmortem/postmortem>
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -4,8 +4,8 @@
|
||||||
|
|
||||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||||
|
|
||||||
Postmortem documentation
|
Newton Postmortem documentation
|
||||||
========================
|
===============================
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,8 @@
|
||||||
|
=====
|
||||||
|
Ocata
|
||||||
|
=====
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
[Postmortem] <postmortem/postmortem>
|
|
@ -4,8 +4,8 @@
|
||||||
|
|
||||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||||
|
|
||||||
Postmortem documentation
|
Ocata Postmortem documentation
|
||||||
========================
|
==============================
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
====
|
||||||
|
Pike
|
||||||
|
====
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -0,0 +1,5 @@
|
||||||
|
======
|
||||||
|
Queens
|
||||||
|
======
|
||||||
|
|
||||||
|
No spec document landed.
|
|
@ -1,31 +0,0 @@
|
||||||
..
|
|
||||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
|
||||||
License.
|
|
||||||
|
|
||||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
|
||||||
|
|
||||||
==================
|
|
||||||
(Placeholder Spec)
|
|
||||||
==================
|
|
||||||
|
|
||||||
This file is just a placeholder for the specs directory.
|
|
||||||
It will be removed soon after some spec is merged.
|
|
||||||
|
|
||||||
The latest spec template is found at ``specs/template.rst``
|
|
||||||
in the ``neutron-specs`` repository.
|
|
||||||
|
|
||||||
Problem Description
|
|
||||||
===================
|
|
||||||
|
|
||||||
Sphinx toctree complains if no file exists in a directory
|
|
||||||
specified in toctree glob.
|
|
||||||
|
|
||||||
Proposed Change
|
|
||||||
===============
|
|
||||||
|
|
||||||
Add this file.
|
|
||||||
|
|
||||||
References
|
|
||||||
==========
|
|
||||||
|
|
||||||
None.
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
=====
|
||||||
|
Rocky
|
||||||
|
=====
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -0,0 +1,11 @@
|
||||||
|
==============
|
||||||
|
Stadium Health
|
||||||
|
==============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Queens <queens/index>
|
||||||
|
Pike <pike/index>
|
||||||
|
Ocata <ocata/index>
|
|
@ -228,6 +228,15 @@ Summary
|
||||||
|
|
||||||
(*) To re-apply for inclusion in Pike or future releases.
|
(*) To re-apply for inclusion in Pike or future releases.
|
||||||
|
|
||||||
|
Scorecards
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
||||||
|
|
||||||
How Reconcile API and client bindings
|
How Reconcile API and client bindings
|
||||||
=====================================
|
=====================================
|
||||||
|
|
|
@ -29,3 +29,12 @@ Summary
|
||||||
+===================================================================+===============+===============+===============+===============+===============+===============+
|
+===================================================================+===============+===============+===============+===============+===============+===============+
|
||||||
| `placeholder <./pike/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD |
|
| `placeholder <./pike/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD |
|
||||||
+-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
|
+-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
|
||||||
|
|
||||||
|
Scorecards
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
|
@ -29,3 +29,12 @@ Summary
|
||||||
+===================================================================+===============+===============+===============+===============+===============+===============+
|
+===================================================================+===============+===============+===============+===============+===============+===============+
|
||||||
| `placeholder <./queens/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD |
|
| `placeholder <./queens/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD |
|
||||||
+-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
|
+-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
|
||||||
|
|
||||||
|
Scorecards
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
*
|
Loading…
Reference in New Issue