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 <sean.mcginnis@gmail.com>
This commit is contained in:
parent
e49d015f24
commit
3bee5129d7
2
NEWS.rst
2
NEWS.rst
@ -7,7 +7,7 @@ bindep.txt does not exist. If both exist and the -f/--file option is
|
|||||||
not specified, it will emit an error.
|
not specified, it will emit an error.
|
||||||
|
|
||||||
Backward-Incompatible Changes Between 1.0.0 and 2.0.0
|
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
|
The following behavior changes between the 1.0.0 and 2.0.0 releases
|
||||||
break backward compatibility:
|
break backward compatibility:
|
||||||
|
@ -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.
|
installed before `pip` can be used - such as `virtualenv` and `pip` itself.
|
||||||
|
|
||||||
Basics
|
Basics
|
||||||
======
|
------
|
||||||
|
|
||||||
Create a file called ``bindep.txt`` and in that list any
|
Create a file called ``bindep.txt`` and in that list any
|
||||||
requirements your application / library has. In your README or INSTALL or
|
requirements your application / library has. In your README or INSTALL or
|
||||||
@ -57,7 +57,7 @@ available profiles::
|
|||||||
|
|
||||||
|
|
||||||
Writing Requirements Files
|
Writing Requirements Files
|
||||||
==========================
|
--------------------------
|
||||||
|
|
||||||
The requirements file ``bindep.txt`` lists the dependencies for
|
The requirements file ``bindep.txt`` lists the dependencies for
|
||||||
projects. Where non-ascii characters are needed, they should be UTF8 encoded.
|
projects. Where non-ascii characters are needed, they should be UTF8 encoded.
|
||||||
@ -147,7 +147,7 @@ following example::
|
|||||||
If you need to distinguish between operating systems where python2 or python3
|
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.
|
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
|
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)]
|
python3-lxml [(platform:redhat platform:base-py3)]
|
||||||
python-lxml [(platform:redhat platform:base-py2)]
|
python-lxml [(platform:redhat platform:base-py2)]
|
||||||
|
Loading…
x
Reference in New Issue
Block a user