From 3bee5129d72497070de7ded454ae88c2ad7e2634 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Tue, 21 Jul 2020 19:19:26 -0500 Subject: [PATCH] Fix formatting issues in docs This fixes incorrect block quoting, title level, and other minor formatting issues with the generated docs. Change-Id: I07d62e54ec837793119fa9f80d610d715bcafdbd Signed-off-by: Sean McGinnis --- CONTRIBUTING.rst | 4 ++-- NEWS.rst | 10 +++++----- README.rst | 12 ++++++------ 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8ad4728..9ec3f95 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,11 +5,11 @@ OpenDev's tools are hosted within the OpenDev collaboratory, and development for them uses workflows described in the OpenDev Infrastructure Manual: - http://docs.opendev.org/opendev/manual/developers.html +http://docs.opendev.org/opendev/manual/developers.html Defect reporting and task tracking takes place here: - https://storyboard.openstack.org/#!/project/opendev/bindep +https://storyboard.openstack.org/#!/project/opendev/bindep Developing bindep ================= diff --git a/NEWS.rst b/NEWS.rst index 7d665fe..5baebe5 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -7,12 +7,12 @@ bindep.txt does not exist. If both exist and the -f/--file option is not specified, it will emit an error. Backward-Incompatible Changes Between 1.0.0 and 2.0.0 -===================================================== +----------------------------------------------------- The following behavior changes between the 1.0.0 and 2.0.0 releases break backward compatibility: - * Running under Python 2.6 is no longer officially supported - * If any platform profiles are listed for a package, at least one - of them must match independently of whether any user profiles - also match +* Running under Python 2.6 is no longer officially supported +* If any platform profiles are listed for a package, at least one + of them must match independently of whether any user profiles + also match diff --git a/README.rst b/README.rst index 29354cb..c4f0273 100644 --- a/README.rst +++ b/README.rst @@ -9,7 +9,7 @@ not Python based, and particularly for testing, some dependencies have to be installed before `pip` can be used - such as `virtualenv` and `pip` itself. Basics -====== +------ Create a file called ``bindep.txt`` and in that list any requirements your application / library has. In your README or INSTALL or @@ -57,7 +57,7 @@ available profiles:: Writing Requirements Files -========================== +-------------------------- The requirements file ``bindep.txt`` lists the dependencies for projects. Where non-ascii characters are needed, they should be UTF8 encoded. @@ -74,9 +74,9 @@ considered when checking dependencies. Profile selectors are a list of space separated strings contained in ``[]``. A selector prefixed with ``!`` is a negative selector. For a line in the requirements file to be active: - * it must not have a negative selector that matches the active profile. - * it must either have no positive selectors, or a positive selector that - matches the active profile. +* it must not have a negative selector that matches the active profile. +* it must either have no positive selectors, or a positive selector that + matches the active profile. For instance, the profile selector ``[!qpid]`` will match every profile except ``qpid`` and would be suitable for disabling installation of rabbitmq when qpid @@ -147,7 +147,7 @@ following example:: If you need to distinguish between operating systems where python2 or python3 is the official interpreter, you can use `base-py2` and `base-py3` labels. Keep in mind that only one would be exposed for a specific operating system -even if the system could support installation of multiple python versions. +even if the system could support installation of multiple python versions:: python3-lxml [(platform:redhat platform:base-py3)] python-lxml [(platform:redhat platform:base-py2)]