DOC: Clarifying doc/make.py --single parameter (#25482)

pandas-dev · Mar 1, 2019 · 011f0a6 · 011f0a6
1 parent 9bb98b8
commit 011f0a6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/doc/make.py b/doc/make.py
@@ -294,14 +294,16 @@ 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
@@ -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