x/mogan-specs
Code Issues Proposed changes
Baremetal Compute (Mogan) Specifications
9 Commits 1 Branch 0 Tags 515 KiB
reStructuredText 91.8%
Python 8.2%
e635f29965
Go to file
bhavani.cr e635f29965 Remove pbr warnerrors in favor of sphinx check 
This change removes the now unused "warnerrors" setting,
which is replaced by "warning-is-error" in sphinx
releases >= 1.5[0]. This also fixes any warnings
that came up when testing with the latest version
of sphinx:

- Redundant loading of todo extension
- Empty man_pages config value

Also updated the requirements for pbr and sphinx to the latest
version(s) in requirements.txt

With this change, any doc warnings will cause the build to fail
[0] http://lists.openstack.org/pipermail/openstack-dev/2017-March/113085.html

Change-Id: Id828161e866da6766d88ce553a3c5ea2593b8f84
2017-06-27 14:41:54 +05:30
doc/source Remove pbr warnerrors in favor of sphinx check 2017-06-27 14:41:54 +05:30
specs New flavor for baremetal servers 2017-06-22 20:45:02 +08:00
tests Add mogan spec template and tests 2017-01-17 16:47:19 +08:00
.gitignore Initial import 2017-01-13 12:50:50 +08:00
.gitreview Update .gitreview 2017-01-13 06:11:38 +00:00
.testr.conf Initial import 2017-01-13 12:50:50 +08:00
LICENSE Initial import 2017-01-13 12:50:50 +08:00
README.rst Initial import 2017-01-13 12:50:50 +08:00
requirements.txt Remove pbr warnerrors in favor of sphinx check 2017-06-27 14:41:54 +05:30
setup.cfg Remove pbr warnerrors in favor of sphinx check 2017-06-27 14:41:54 +05:30
setup.py Initial import 2017-01-13 12:50:50 +08:00
test-requirements.txt Initial import 2017-01-13 12:50:50 +08:00
tox.ini Initial import 2017-01-13 12:50:50 +08:00

README.rst

OpenStack Baremetal Computing Specifications

This git repository is used to hold approved design specifications for additions to the Baremetal Provisioning program, and in particular, the Mogan project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

Specifications must follow the template which can be found at specs/template.rst.

blueprints:

http://blueprints.launchpad.net/mogan

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.

To quickly preview just the rst syntax rendering (without Sphinx features) of a single spec file execute the following command:

$ tox -evenv rst2html.py <path-to-your-spec.rst> <path-to-output.html>

and open <path-to-output.html> in your browser. Running full tox is still advised before submitting your patch.