Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct documentation on make.py --single parameter #25482

Merged
merged 2 commits into from
Mar 1, 2019
Merged

Correct documentation on make.py --single parameter #25482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70418bd
Correct documentation on make.py --single
MaxVanDeursen Feb 28, 2019
ca236d1
Fix PEP8 issues
MaxVanDeursen Feb 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions doc/make.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
6 changes: 3 additions & 3 deletions doc/source/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down