From 70418bd72dc124faebaee110f8315c120513dd87 Mon Sep 17 00:00:00 2001 From: Max van Deursen Date: Thu, 28 Feb 2019 20:46:04 +0100 Subject: [PATCH 1/2] Correct documentation on make.py --single In this commit, the documentation on the use of the --single parameter when using the make.py script is corrected, for the use of building a single .rst file. --- doc/make.py | 7 ++++--- doc/source/development/contributing.rst | 6 +++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/make.py b/doc/make.py index 438c4a04a3f08..9846ab9c6b539 100755 --- a/doc/make.py +++ b/doc/make.py @@ -294,14 +294,15 @@ def main(): help='number of jobs used by sphinx-build') argparser.add_argument('--no-api', default=False, - help='ommit api and autosummary', + help='omit api and autosummary', action='store_true') argparser.add_argument('--single', metavar='FILENAME', type=str, default=None, - help=('filename of section or method name to ' - 'compile, e.g. "indexing", "DataFrame.join"')) + help=('filename (relative to the "source" folder) of section or method name to ' + 'compile, e.g. "development/contributing.rst",' + ' "ecosystem.rst", "pandas.DataFrame.join"')) argparser.add_argument('--python-path', type=str, default=os.path.dirname(DOC_PATH), diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 027f2d90bbb73..a87a66cd08ad1 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -428,10 +428,10 @@ reducing the turn-around time for checking your changes. python make.py clean python make.py --no-api - # compile the docs with only a single - # section, that which is in indexing.rst + # compile the docs with only a single section, relative to the "source" folder. + # For example, compiling only this guide (docs/source/development/contributing.rst) python make.py clean - python make.py --single indexing + python make.py --single development/contributing.rst # compile the reference docs for a single function python make.py clean From ca236d1ca9ed77cc7f6ba43a4b76cbea8ab00b67 Mon Sep 17 00:00:00 2001 From: Max van Deursen Date: Thu, 28 Feb 2019 20:49:16 +0100 Subject: [PATCH 2/2] Fix PEP8 issues --- doc/make.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/make.py b/doc/make.py index 9846ab9c6b539..8b2a77987e663 100755 --- a/doc/make.py +++ b/doc/make.py @@ -300,8 +300,9 @@ def main(): metavar='FILENAME', type=str, default=None, - help=('filename (relative to the "source" folder) of section or method name to ' - 'compile, e.g. "development/contributing.rst",' + help=('filename (relative to the "source" folder)' + ' of section or method name to compile, e.g. ' + '"development/contributing.rst",' ' "ecosystem.rst", "pandas.DataFrame.join"')) argparser.add_argument('--python-path', type=str,