From 810df79e6f5207e922f1a81d61937a67c7e5810a Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Mon, 19 May 2014 10:04:21 -0700 Subject: [PATCH] Add a few files from the openstack cookiecutter template --- CONTRIBUTING.rst | 13 +++++++++++++ HACKING.rst | 4 ++++ MANIFEST.in | 5 +++++ README.rst | 5 +++++ 4 files changed, 27 insertions(+) create mode 100644 CONTRIBUTING.rst create mode 100644 HACKING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..e505e3b --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,13 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in the "If you're a developer, start here" +section of this page: + + http://wiki.openstack.org/HowToContribute + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://wiki.openstack.org/GerritWorkflow + +Pull requests submitted through GitHub will be ignored. \ No newline at end of file diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..97c6879 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,4 @@ +doc8 Style Commandments +=============================================== + +Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in index 9561fb1..762d33b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,6 @@ include README.rst + +exclude .gitignore +exclude .gitreview + +global-exclude *.pyc diff --git a/README.rst b/README.rst index c2af63a..28e38ad 100644 --- a/README.rst +++ b/README.rst @@ -5,6 +5,11 @@ Doc8 Doc8 is a *opinionated* style checker for sphinx (or other) `rst`_ documentation. +Features +-------- + +* Ability to parse and validate rst files. + QuickStart ==========