diff --git a/docs/README.txt b/docs/README.txt index 212096213..4bb548372 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -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 -` \ No newline at end of file +` diff --git a/docs/conf.py b/docs/conf.py index 37ab0060c..592a1057d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ sys.path.append(os.path.abspath(os.pardir)) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -41,16 +41,16 @@ master_doc = 'index' # General information about the project. project = u'Gramps' -copyright = u'2012, The Gramps Project' +copyright = u'2014, The Gramps Project' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '4.1' +version = '4.2.0' # The full version, including alpha/beta/rc tags. -release = '4.0.99-trunk' +release = '4.2.0-master' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index c93ac6631..d410b37ca 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -1,4 +1,4 @@ Developer Guide =============== -Please consult the API documentation, and the development part of `our wiki `_\ . +Please consult the API documentation, and the development section of `our wiki `_\ . diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 9a2eda0e7..5cf5d2ee4 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -1,4 +1,4 @@ User Guide ========== -Please consult the manual which you find on `our wiki `_\ . \ No newline at end of file +Please consult the manual which you find on `our wiki `_\ . diff --git a/gramps/gen/plug/_manager.py b/gramps/gen/plug/_manager.py index 8140259e0..7279d4a80 100644 --- a/gramps/gen/plug/_manager.py +++ b/gramps/gen/plug/_manager.py @@ -385,14 +385,14 @@ class BasePluginManager(object): def get_reg_reports(self, gui=True): """ Return list of registered reports :param gui: bool indicating if GUI reports or CLI reports must be - returned + returned """ return self.__pgr.report_plugins(gui) def get_reg_tools(self, gui=True): """ Return list of registered tools :aram gui: bool indicating if GUI reports or CLI reports must be - returned + returned """ return self.__pgr.tool_plugins(gui) diff --git a/gramps/gui/pluginmanager.py b/gramps/gui/pluginmanager.py index f4ca3d4d8..51833b94b 100644 --- a/gramps/gui/pluginmanager.py +++ b/gramps/gui/pluginmanager.py @@ -247,7 +247,7 @@ class GuiPluginManager(Callback): def get_reg_reports(self, gui=True): """ Return list of non hidden registered reports :Param gui: bool indicating if GUI reports or CLI reports must be - returned + returned """ return [plg for plg in self.basemgr.get_reg_reports(gui) if plg.id not in self.__hidden_plugins] @@ -255,7 +255,7 @@ class GuiPluginManager(Callback): def get_reg_tools(self, gui=True): """ Return list of non hidden registered tools :Param gui: bool indicating if GUI reports or CLI reports must be - returned + returned """ return [plg for plg in self.basemgr.get_reg_tools(gui) if plg.id not in self.__hidden_plugins]