Update to follow style guide 36/41536/3
authorThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 8 Jul 2016 04:31:30 +0000 (00:31 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 8 Jul 2016 04:53:08 +0000 (00:53 -0400)
commit490600fcefeb3c269d3cba5eb8af09604027758e
tree7264423c37e3e515e61a224b915a895e00ae7e5c
parentdafabd23238d1a5bc48416b9fa82c9159afb9f62
Update to follow style guide

The Python Style guide recommends the following:

  # with overline, for parts
  * with overline, for chapters
  =, for sections
  -, for subsections
  ^, for subsubsections
  ", for paragraphs

Update the getting-started-guide and openstack-guide and documentation
guide to use parts and chapters. We should be following this project
structure:

docs/index.rst                 -> entry point
docs/____-guide/index.rst      -> part
docs/____-guide/<chapter>.rst  -> chapter

In the ____-guide/index.rst we use the # with overline at the very top
of the file to determine that it is a part and then within each chapter
file we start the document with a section using * with overline to
denote that it's the chapter heading and then everything in the rest of
the chapter should use:

  =, for sections
  -, for subsections
  ^, for subsubsections
  ", for paragraphs

Change-Id: I4429eecc17d2e667c1f00236f9a57bc9a9028e29
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
16 files changed:
docs/documentation.rst
docs/getting-started-guide/api.rst
docs/getting-started-guide/common-features/index.rst
docs/getting-started-guide/concepts_and_tools.rst
docs/getting-started-guide/experimental_features.rst
docs/getting-started-guide/index.rst
docs/getting-started-guide/installing_opendaylight.rst
docs/getting-started-guide/introduction.rst
docs/getting-started-guide/karaf_features.rst
docs/getting-started-guide/other_features.rst
docs/getting-started-guide/overview.rst
docs/getting-started-guide/project-specific-guides/index.rst
docs/getting-started-guide/release_notes.rst
docs/getting-started-guide/security_considerations.rst
docs/getting-started-guide/who_should_use.rst
docs/opendaylight-with-openstack/index.rst