respect sphinx style guide to some extent

see http://documentation-style-guide-sphinx.readthedocs.org/en/latest/style-guide.html
This commit is contained in:
Frank Morgner
2013-03-05 20:42:09 +01:00
parent 9be74c7886
commit 37e5f9d514
74 changed files with 488 additions and 264 deletions

20
doc/autotools.txt.in Normal file
View File

@@ -0,0 +1,20 @@
.. highlight:: sh
************
Installation
************
The @PACKAGE_NAME@ uses the GNU Build System to compile and install. If you are
unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look
around and can not find it, you are probably working bleeding edge in the
repository. Run the following command in :file:`@PACKAGE_TARNAME@` to
get the missing standard auxiliary files::
autoreconf --verbose --install
To configure (:command:`configure --help` lists possible options), build and
install the @PACKAGE_NAME@ now do the following::
./configure@RECOMMENDED_CONF_OPTS@
make
make install