From 5b8f5dffbe64567a43ba29dfa96b98148e7bdcd7 Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Mon, 30 May 2016 18:33:22 +0900 Subject: [PATCH] Fix docs warnings and errors This commit fixes docs and warnings. But I left some warnings such as ChangeLog and external image URIs. Because ChangeLog is generated from git log. And to fix the external image URIs, it needs needs an ugly workaround that is replacing it to raw html. Change-Id: Ieecc640fdf5d54d138eeb963ff9ef8cd1c9eaa4a --- README.rst | 2 +- doc/source/_static/.keep | 0 doc/source/conf.py | 2 +- doc/source/db_api.rst | 4 ---- doc/source/index.rst | 1 + subunit2sql/db/api.py | 2 +- 6 files changed, 4 insertions(+), 7 deletions(-) create mode 100644 doc/source/_static/.keep diff --git a/README.rst b/README.rst index 068977b..fb95d0f 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ different format. For multiple distributed test runs that are generating subunit output it is useful to store the results in a unified repository. This is the motivation for -the _`testrepository` project which does a good job for centralizing the +the `testrepository`_ project which does a good job for centralizing the results from multiple test runs. .. _testrepository: http://testrepository.readthedocs.org/en/latest/ diff --git a/doc/source/_static/.keep b/doc/source/_static/.keep new file mode 100644 index 0000000..e69de29 diff --git a/doc/source/conf.py b/doc/source/conf.py index e8b4308..8d40c4f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -49,7 +49,7 @@ copyright = u'2014, Matthew Treinish' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ['_build', 'db_api.rst'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None diff --git a/doc/source/db_api.rst b/doc/source/db_api.rst index bf11f95..74f9b0b 100644 --- a/doc/source/db_api.rst +++ b/doc/source/db_api.rst @@ -1,7 +1,3 @@ ----------- -The DB API ----------- - .. automodule:: subunit2sql.db.api :noindex: :members: diff --git a/doc/source/index.rst b/doc/source/index.rst index cf6fac1..583cd80 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,7 @@ Contents: data_model api graph + target-extensions history diff --git a/subunit2sql/db/api.py b/subunit2sql/db/api.py index f09ef34..201f4fe 100644 --- a/subunit2sql/db/api.py +++ b/subunit2sql/db/api.py @@ -1101,7 +1101,7 @@ def get_recent_runs_by_key_value_metadata(key, value, num_runs=10, date will be returned. :return list: A list of run objects for the most recent runs. - :rtype subunit2sql.db.models.Run + :rtype: subunit2sql.db.models.Run """ session = session or get_session() results = db_utils.model_query(models.Run, session).join(