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

View File

@@ -1,8 +1,8 @@
.. 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

View File

@@ -41,7 +41,7 @@ extensions = ["breathe", "sphinxcontrib.doxylink", "sphinx.ext.autosummary", "sp
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = '.txt'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
@@ -74,7 +74,7 @@ release = '2012-04-11'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', '*/questions.rst', '*/autotools.rst', '*/download.rst']
exclude_patterns = ['_build', '*/questions.txt', '*/autotools.txt', '*/download.txt']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

View File

@@ -1,8 +1,8 @@
.. highlight:: sh
===============================================================================
********
Download
===============================================================================
********
You can find the latest release of @PACKAGE_NAME@ `here
<http://sourceforge.net/projects/vsmartcard/files>`_.

View File

@@ -1,6 +1,6 @@
========
********
Question
========
********
Do you have questions, suggestions or contributions? Feedback of any kind is
more than welcome! Please use our `project trackers <@PACKAGE_BUGREPORT@>`_.