6028: Cleaned up and improved the Gramps API docs, Sphinx - fixed four ERROR: Unexpected indentation, added 'sphinx.ext.viewcode' to allow Sphinx to 'Add links to highlighted source code' http://sphinx-doc.org/latest/ext/viewcode.html , updated the copyright year and instructions to use pip
This commit is contained in:
committed by
Jérôme Rapinat
parent
453b339775
commit
e2e4d3c57a
@@ -3,7 +3,9 @@ Installation and building the docs
|
||||
|
||||
You need to install sphinx. Assuming you have installed the python setuptools, just do:
|
||||
|
||||
sudo easy_install sphinx
|
||||
sudo easy_install sphinx
|
||||
or
|
||||
sudo pip install sphinx
|
||||
|
||||
Once installed, go to the docs directory, and do:
|
||||
|
||||
@@ -17,7 +19,7 @@ Documentation Guidelines
|
||||
|
||||
Doc strings in python files should be written in reStructured text: http://docutils.sourceforge.net/docs/user/rst/quickref.html
|
||||
|
||||
The typical docstring for GRAMPS should look like this:
|
||||
The typical docstring for Gramps should look like this:
|
||||
|
||||
"""Brief synopsis
|
||||
|
||||
@@ -69,4 +71,4 @@ Change in many files something:
|
||||
perl -pi -w -e "s/L{PersonRef}/:class:\`\~gen.lib.personref.PersonRef\`/g;" *.py
|
||||
|
||||
here L{PersonRef} is changed in :class:`~gen.lib.personref.PersonRef
|
||||
`
|
||||
`
|
||||
|
||||
Reference in New Issue
Block a user