Browse Source

Initial commit

Spec repo created using the specs-cookiecutter repo [1].

[1] https://git.openstack.org/cgit/openstack-dev/specs-cookiecutter

Change-Id: Id6ed56d21ff0984ea7394e21b204a99cd2237956
Spyros Trigazis 2 years ago
parent
commit
74da0acf5d
15 changed files with 416 additions and 0 deletions
  1. 54
    0
      .gitignore
  2. 21
    0
      CONTRIBUTING.rst
  3. 3
    0
      LICENSE
  4. 6
    0
      MANIFEST.in
  5. 13
    0
      README.rst
  6. 93
    0
      doc/source/conf.py
  7. 21
    0
      doc/source/contributing.rst
  8. 32
    0
      doc/source/index.rst
  9. 13
    0
      doc/source/readme.rst
  10. 86
    0
      doc/source/template.rst
  11. 4
    0
      requirements.txt
  12. 24
    0
      setup.cfg
  13. 21
    0
      setup.py
  14. 0
    0
      test-requirements.txt
  15. 25
    0
      tox.ini

+ 54
- 0
.gitignore View File

@@ -0,0 +1,54 @@
1
+*.py[cod]
2
+
3
+# C extensions
4
+*.so
5
+
6
+# Packages
7
+*.egg
8
+*.egg-info
9
+dist
10
+build
11
+eggs
12
+parts
13
+bin
14
+var
15
+sdist
16
+develop-eggs
17
+.installed.cfg
18
+lib
19
+lib64
20
+
21
+# Installer logs
22
+pip-log.txt
23
+
24
+# Unit test / coverage reports
25
+.coverage
26
+.tox
27
+nosetests.xml
28
+.testrepository
29
+
30
+# Translations
31
+*.mo
32
+
33
+# Mr Developer
34
+.mr.developer.cfg
35
+.project
36
+.pydevproject
37
+
38
+# Complexity
39
+output/*.html
40
+output/*/index.html
41
+
42
+# Sphinx
43
+doc/build
44
+
45
+# pbr generates these
46
+AUTHORS
47
+ChangeLog
48
+
49
+# Editors
50
+*~
51
+.*.swp
52
+
53
+# MACs
54
+.DS_Store

+ 21
- 0
CONTRIBUTING.rst View File

@@ -0,0 +1,21 @@
1
+=============================================
2
+Contributing to: magnum-specs
3
+=============================================
4
+
5
+If you would like to contribute to the development of OpenStack, you must
6
+follow the steps in this page:
7
+
8
+   http://docs.openstack.org/infra/manual/developers.html
9
+
10
+If you already have a good understanding of how the system works and your
11
+OpenStack accounts are set up, you can skip to the development workflow
12
+section of this documentation to learn how changes to OpenStack should be
13
+submitted for review via the Gerrit tool:
14
+
15
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
16
+
17
+Pull requests submitted through GitHub will be ignored.
18
+
19
+Bugs should be filed on Launchpad, not GitHub:
20
+
21
+   https://bugs.launchpad.net/magnum

+ 3
- 0
LICENSE View File

@@ -0,0 +1,3 @@
1
+This work is licensed under a Creative Commons Attribution 3.0 Unported License.
2
+
3
+http://creativecommons.org/licenses/by/3.0/legalcode

+ 6
- 0
MANIFEST.in View File

@@ -0,0 +1,6 @@
1
+include AUTHORS
2
+include ChangeLog
3
+exclude .gitignore
4
+exclude .gitreview
5
+
6
+global-exclude *.pyc

+ 13
- 0
README.rst View File

@@ -0,0 +1,13 @@
1
+===============================
2
+magnum-specs
3
+===============================
4
+
5
+Design specifications for Magnum
6
+
7
+* Free software: Apache license
8
+* Documentation: http://docs.openstack.org/developer/magnum-specs
9
+
10
+Features
11
+--------
12
+
13
+* TODO

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

@@ -0,0 +1,93 @@
1
+# -*- coding: utf-8 -*-
2
+# Licensed under the Apache License, Version 2.0 (the "License");
3
+# you may not use this file except in compliance with the License.
4
+# You may obtain a copy of the License at
5
+#
6
+#    http://www.apache.org/licenses/LICENSE-2.0
7
+#
8
+# Unless required by applicable law or agreed to in writing, software
9
+# distributed under the License is distributed on an "AS IS" BASIS,
10
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11
+# implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+import datetime
16
+import os
17
+import sys
18
+
19
+sys.path.insert(0, os.path.abspath('../..'))
20
+# -- General configuration ----------------------------------------------------
21
+
22
+# Add any Sphinx extension module names here, as strings. They can be
23
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
24
+extensions = [
25
+    'sphinx.ext.autodoc',
26
+    #'sphinx.ext.intersphinx',
27
+    'oslosphinx',
28
+    'yasfb',
29
+]
30
+
31
+# Feed configuration for yasfb
32
+feed_base_url = 'http://specs.openstack.org/openstack/magnum-specs'
33
+feed_author = 'OpenStack Development Team'
34
+
35
+exclude_patterns = [
36
+    'template.rst',
37
+]
38
+
39
+# Optionally allow the use of sphinxcontrib.spelling to verify the
40
+# spelling of the documents.
41
+try:
42
+    import sphinxcontrib.spelling
43
+    extensions.append('sphinxcontrib.spelling')
44
+except ImportError:
45
+    pass
46
+
47
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
48
+# text edit cycles.
49
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
50
+
51
+# The suffix of source filenames.
52
+source_suffix = '.rst'
53
+
54
+# The master toctree document.
55
+master_doc = 'index'
56
+
57
+# General information about the project.
58
+project = u'magnum-specs'
59
+copyright = u'%s, OpenStack Foundation' % datetime.date.today().year
60
+
61
+# If true, '()' will be appended to :func: etc. cross-reference text.
62
+add_function_parentheses = True
63
+
64
+# If true, the current module name will be prepended to all description
65
+# unit titles (such as .. function::).
66
+add_module_names = True
67
+
68
+# The name of the Pygments (syntax highlighting) style to use.
69
+pygments_style = 'sphinx'
70
+
71
+# -- Options for HTML output --------------------------------------------------
72
+
73
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
74
+# Sphinx are currently 'default' and 'sphinxdoc'.
75
+# html_theme_path = ["."]
76
+# html_theme = '_theme'
77
+# html_static_path = ['static']
78
+
79
+# Output file base name for HTML help builder.
80
+htmlhelp_basename = '%sdoc' % project
81
+
82
+# Grouping the document tree into LaTeX files. List of tuples
83
+# (source start file, target name, title, author, documentclass
84
+# [howto/manual]).
85
+latex_documents = [
86
+    ('index',
87
+     '%s.tex' % project,
88
+     u'%s Documentation' % project,
89
+     u'OpenStack Foundation', 'manual'),
90
+]
91
+
92
+# Example configuration for intersphinx: refer to the Python standard library.
93
+#intersphinx_mapping = {'http://docs.python.org/': None}

+ 21
- 0
doc/source/contributing.rst View File

@@ -0,0 +1,21 @@
1
+=============================================
2
+Contributing to: magnum-specs
3
+=============================================
4
+
5
+If you would like to contribute to the development of OpenStack, you must
6
+follow the steps in this page:
7
+
8
+   http://docs.openstack.org/infra/manual/developers.html
9
+
10
+If you already have a good understanding of how the system works and your
11
+OpenStack accounts are set up, you can skip to the development workflow
12
+section of this documentation to learn how changes to OpenStack should be
13
+submitted for review via the Gerrit tool:
14
+
15
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
16
+
17
+Pull requests submitted through GitHub will be ignored.
18
+
19
+Bugs should be filed on Launchpad, not GitHub:
20
+
21
+   https://bugs.launchpad.net/magnum

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

@@ -0,0 +1,32 @@
1
+.. magnum-specs 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
+magnum-specs Design Specifications
7
+==================================================
8
+
9
+.. toctree::
10
+   :glob:
11
+   :maxdepth: 2
12
+
13
+   specs/*
14
+
15
+
16
+magnum-specs Repository Information
17
+===================================================
18
+
19
+.. toctree::
20
+   :maxdepth: 2
21
+
22
+   README <readme>
23
+   contributing
24
+
25
+
26
+Indices and tables
27
+==================
28
+
29
+* :ref:`genindex`
30
+* :ref:`modindex`
31
+* :ref:`search`
32
+

+ 13
- 0
doc/source/readme.rst View File

@@ -0,0 +1,13 @@
1
+===============================
2
+magnum-specs
3
+===============================
4
+
5
+Design specifications for Magnum
6
+
7
+* Free software: Apache license
8
+* Documentation: http://docs.openstack.org/developer/magnum-specs
9
+
10
+Features
11
+--------
12
+
13
+* TODO

+ 86
- 0
doc/source/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/magnum/+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/magnum/+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 magnum 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 magnum, 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?

+ 4
- 0
requirements.txt View File

@@ -0,0 +1,4 @@
1
+pbr>=0.11,<2.0
2
+oslosphinx
3
+sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
4
+yasfb>=0.5.1

+ 24
- 0
setup.cfg View File

@@ -0,0 +1,24 @@
1
+[metadata]
2
+name = magnum-specs
3
+summary = Design specifications for Magnum
4
+description-file =
5
+    README.rst
6
+author = OpenStack
7
+author-email = openstack-dev@lists.openstack.org
8
+home-page = http://www.openstack.org/
9
+classifier =
10
+    Environment :: OpenStack
11
+    Intended Audience :: Developers
12
+    License :: OSI Approved :: Apache Software License
13
+    Operating System :: POSIX :: Linux
14
+
15
+[build_sphinx]
16
+source-dir = doc/source
17
+build-dir = doc/build
18
+all_files = 1
19
+
20
+[pbr]
21
+warnerrors = True
22
+
23
+[upload_sphinx]
24
+upload-dir = doc/build/html

+ 21
- 0
setup.py View File

@@ -0,0 +1,21 @@
1
+#!/usr/bin/env python
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License");
4
+# you may not use this file except in compliance with the License.
5
+# You may obtain a copy of the License at
6
+#
7
+#    http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS,
11
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12
+# implied.
13
+# See the License for the specific language governing permissions and
14
+# limitations under the License.
15
+
16
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
17
+import setuptools
18
+
19
+setuptools.setup(
20
+    setup_requires=['pbr'],
21
+    pbr=True)

+ 0
- 0
test-requirements.txt View File


+ 25
- 0
tox.ini View File

@@ -0,0 +1,25 @@
1
+[tox]
2
+minversion = 1.6
3
+envlist = docs
4
+skipsdist = True
5
+
6
+[testenv]
7
+usedevelop = True
8
+install_command = pip install -U {opts} {packages}
9
+setenv =
10
+   VIRTUAL_ENV={envdir}
11
+deps = -r{toxinidir}/requirements.txt
12
+       -r{toxinidir}/test-requirements.txt
13
+
14
+[testenv:venv]
15
+commands = {posargs}
16
+
17
+[testenv:docs]
18
+commands = python setup.py build_sphinx
19
+
20
+[testenv:spelling]
21
+deps =
22
+   -r{toxinidir}/requirements.txt
23
+   sphinxcontrib-spelling
24
+   PyEnchant
25
+commands = sphinx-build -b spelling doc/source doc/build/spelling

Loading…
Cancel
Save