Skip to content

DOC: Fix building of a single API document #24506

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

Merged
merged 1 commit into from
Dec 30, 2018
+3 −4
Merged

DOC: Fix building of a single API document #24506

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion doc/make.py
View file
Original file line number Diff line number Diff line change
@@ -50,7 +50,7 @@ def __init__(self, num_jobs=0, include_api=True, single_doc=None,
if single_doc and single_doc.endswith('.rst'):
self.single_doc_html = os.path.splitext(single_doc)[0] + '.html'
elif single_doc:
self.single_doc_html = 'generated/pandas.{}.html'.format(
self.single_doc_html = 'api/generated/pandas.{}.html'.format(
single_doc)

def _process_single_doc(self, single_doc):
3 changes: 1 addition & 2 deletions doc/source/conf.py
View file
Original file line number Diff line number Diff line change
@@ -98,8 +98,7 @@
if (fname == 'index.rst'
and os.path.abspath(dirname) == source_path):
continue
elif (pattern == '-api'
and (fname == 'api.rst' or dirname == 'generated')):
elif pattern == '-api' and dirname == 'api':
exclude_patterns.append(fname)
elif fname != pattern:
exclude_patterns.append(fname)
2 changes: 1 addition & 1 deletion doc/source/index.rst.template
View file
Original file line number Diff line number Diff line change
@@ -113,7 +113,7 @@ See the package overview for more detail about what's in the library.
{{ single_doc[:-4] }}
{% elif single_doc %}
.. autosummary::
:toctree: generated/
:toctree: api/generated/

{{ single_doc }}
{% else -%}