Browse Source

Add specs to documentation

This commit adds a spec folder within documentation. This would be
moved under its own project if it starts growing big enough.

Change-Id: I54b8402b35ff72577f1b949d9a081752cb08a13b
Daniel Mellado 2 years ago
parent
commit
fa360ae63c
5 changed files with 129 additions and 0 deletions
  1. 10
    0
      doc/source/conf.py
  2. 8
    0
      doc/source/index.rst
  3. 86
    0
      doc/source/spec_template.rst
  4. 24
    0
      doc/source/specs/index.rst
  5. 1
    0
      test-requirements.txt

+ 10
- 0
doc/source/conf.py View File

@@ -15,6 +15,8 @@
15 15
 import os
16 16
 import sys
17 17
 
18
+import openstackdocstheme
19
+
18 20
 sys.path.insert(0, os.path.abspath('../..'))
19 21
 # -- General configuration ----------------------------------------------------
20 22
 
@@ -26,6 +28,11 @@ extensions = [
26 28
     'oslosphinx'
27 29
 ]
28 30
 
31
+exclude_patterns = [
32
+    'spec_template.rst',
33
+]
34
+
35
+
29 36
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
30 37
 # text edit cycles.
31 38
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
@@ -57,6 +64,9 @@ pygments_style = 'sphinx'
57 64
 # html_theme_path = ["."]
58 65
 # html_theme = '_theme'
59 66
 # html_static_path = ['static']
67
+html_theme = 'openstackdocs'
68
+
69
+html_theme_path = [openstackdocstheme.get_html_theme_path()]
60 70
 
61 71
 # Output file base name for HTML help builder.
62 72
 htmlhelp_basename = '%sdoc' % project

+ 8
- 0
doc/source/index.rst View File

@@ -16,6 +16,14 @@ Contents:
16 16
    usage
17 17
    contributing
18 18
 
19
+Interop-workloads' blueprints.
20
+==============================
21
+
22
+.. toctree::
23
+   :maxdepth: 1
24
+
25
+   specs/index
26
+
19 27
 Indices and tables
20 28
 ==================
21 29
 

+ 86
- 0
doc/source/spec_template.rst View File

@@ -0,0 +1,86 @@
1
+..
2
+
3
+This work is licensed under a Creative Commons Attribution 3.0 Unported License.
4
+http://creativecommons.org/licenses/by/3.0/legalcode
5
+
6
+..
7
+  This template should be in ReSTructured text. The filename in the git
8
+  repository should match the launchpad URL, for example a URL of
9
+  https://blueprints.launchpad.net/interop-workloads-specs/+spec/awesome-thing should be named
10
+  awesome-thing.rst .  Please do not delete any of the sections in this
11
+  template.  If you have nothing to say for a whole section, just write: None
12
+  For help with syntax, see http://sphinx-doc.org/rest.html
13
+  To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html
14
+
15
+=============================
16
+ The title of your blueprint
17
+=============================
18
+
19
+Include the URL of your launchpad blueprint:
20
+
21
+https://blueprints.launchpad.net/interop-workloads/+spec/example
22
+
23
+Introduction paragraph -- why are we doing anything?
24
+
25
+Problem description
26
+===================
27
+
28
+A detailed description of the problem.
29
+
30
+Proposed change
31
+===============
32
+
33
+Here is where you cover the change you propose to make in detail. How do you
34
+propose to solve this problem?
35
+
36
+If this is one part of a larger effort make it clear where this piece ends. In
37
+other words, what's the scope of this effort?
38
+
39
+Include where in the interop-workloads-specs tree hierarchy this will reside.
40
+
41
+Alternatives
42
+------------
43
+
44
+This is an optional section, where it does apply we'd just like a demonstration
45
+that some thought has been put into why the proposed approach is the best one.
46
+
47
+Implementation
48
+==============
49
+
50
+Assignee(s)
51
+-----------
52
+
53
+Who is leading the writing of the code? Or is this a blueprint where you're
54
+throwing it out there to see who picks it up?
55
+
56
+If more than one person is working on the implementation, please designate the
57
+primary author and contact.
58
+
59
+Primary assignee:
60
+  <launchpad-id or None>
61
+
62
+Can optionally can list additional ids if they intend on doing
63
+substantial implementation work on this blueprint.
64
+
65
+Milestones
66
+----------
67
+
68
+Target Milestone for completion:
69
+  Juno-1
70
+
71
+Work Items
72
+----------
73
+
74
+Work items or tasks -- break the feature up into the things that need to be
75
+done to implement it. Those parts might end up being done by different people,
76
+but we're mostly trying to understand the timeline for implementation.
77
+
78
+
79
+Dependencies
80
+============
81
+
82
+- Include specific references to specs and/or blueprints in interop-workloads-specs, or in other
83
+  projects, that this one either depends on or is related to.
84
+
85
+- Does this feature require any new library dependencies or code otherwise not
86
+  included in OpenStack? Or does it depend on a specific version of library?

+ 24
- 0
doc/source/specs/index.rst View File

@@ -0,0 +1,24 @@
1
+.. interop-workloads documentation master file, created by
2
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
3
+   You can adapt this file completely to your liking, but it should at least
4
+   contain the root `toctree` directive.
5
+
6
+Blueprints for Interop-Workloads
7
+================================
8
+In this section you will find information on blueprints.
9
+
10
+Interop-workloads' blueprints.
11
+------------------------------
12
+
13
+.. toctree::
14
+   :glob:
15
+   :maxdepth: 3
16
+
17
+   *
18
+
19
+Indices and tables
20
+------------------
21
+
22
+* :ref:`genindex`
23
+* :ref:`search`
24
+

+ 1
- 0
test-requirements.txt View File

@@ -9,6 +9,7 @@ python-subunit>=0.0.18 # Apache-2.0/BSD
9 9
 sphinx>=1.2.1,!=1.3b1,<1.4 # BSD
10 10
 oslosphinx>=4.7.0 # Apache-2.0
11 11
 oslotest>=1.10.0 # Apache-2.0
12
+openstackdocstheme>=1.5.0 # Apache-2.0
12 13
 testrepository>=0.0.18  # Apache-2.0/BSD
13 14
 testscenarios>=0.4  # Apache-2.0/BSD
14 15
 testtools>=1.4.0 # MIT

Loading…
Cancel
Save