Skip to content

DOC: add redirects to ensure old links instead of building the docstring page #9911

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions doc/_templates/api_redirect.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{% set pgn = pagename.split('.') -%}
{% if pgn[-2][0].isupper() -%}
{% set redirect = ["pandas", pgn[-2], pgn[-1], 'html']|join('.') -%}
{% else -%}
{% set redirect = ["pandas", pgn[-1], 'html']|join('.') -%}
{% endif -%}
<html>
<head>
<meta http-equiv="Refresh" content="0; url={{ redirect }}" />
<title>This API page has moved</title>
</head>
<body>
<p>This API page has moved <a href="{{ redirect }}">here</a>.</p>
</body>
</html>
227 changes: 0 additions & 227 deletions doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1521,230 +1521,3 @@ Working with options
get_option
set_option
option_context


..
HACK - see github issue #4539. To ensure old links remain valid, include
here the autosummaries with previous currentmodules as a comment and add
them to a hidden toctree (to avoid warnings):

.. toctree::
:hidden:

generated/pandas.core.common.isnull
generated/pandas.core.common.notnull
generated/pandas.core.reshape.get_dummies
generated/pandas.io.clipboard.read_clipboard
generated/pandas.io.excel.ExcelFile.parse
generated/pandas.io.excel.read_excel
generated/pandas.io.html.read_html
generated/pandas.io.json.read_json
generated/pandas.io.parsers.read_csv
generated/pandas.io.parsers.read_fwf
generated/pandas.io.parsers.read_table
generated/pandas.io.pickle.read_pickle
generated/pandas.io.pytables.HDFStore.append
generated/pandas.io.pytables.HDFStore.get
generated/pandas.io.pytables.HDFStore.put
generated/pandas.io.pytables.HDFStore.select
generated/pandas.io.pytables.read_hdf
generated/pandas.io.sql.read_sql
generated/pandas.io.sql.read_frame
generated/pandas.io.sql.write_frame
generated/pandas.io.stata.read_stata
generated/pandas.stats.moments.ewma
generated/pandas.stats.moments.ewmcorr
generated/pandas.stats.moments.ewmcov
generated/pandas.stats.moments.ewmstd
generated/pandas.stats.moments.ewmvar
generated/pandas.stats.moments.expanding_apply
generated/pandas.stats.moments.expanding_corr
generated/pandas.stats.moments.expanding_count
generated/pandas.stats.moments.expanding_cov
generated/pandas.stats.moments.expanding_kurt
generated/pandas.stats.moments.expanding_mean
generated/pandas.stats.moments.expanding_median
generated/pandas.stats.moments.expanding_quantile
generated/pandas.stats.moments.expanding_skew
generated/pandas.stats.moments.expanding_std
generated/pandas.stats.moments.expanding_sum
generated/pandas.stats.moments.expanding_var
generated/pandas.stats.moments.rolling_apply
generated/pandas.stats.moments.rolling_corr
generated/pandas.stats.moments.rolling_count
generated/pandas.stats.moments.rolling_cov
generated/pandas.stats.moments.rolling_kurt
generated/pandas.stats.moments.rolling_mean
generated/pandas.stats.moments.rolling_median
generated/pandas.stats.moments.rolling_quantile
generated/pandas.stats.moments.rolling_skew
generated/pandas.stats.moments.rolling_std
generated/pandas.stats.moments.rolling_sum
generated/pandas.stats.moments.rolling_var
generated/pandas.tools.merge.concat
generated/pandas.tools.merge.merge
generated/pandas.tools.pivot.pivot_table
generated/pandas.tseries.tools.to_datetime

..
.. currentmodule:: pandas.io.pickle

.. autosummary::
:toctree: generated/

read_pickle

.. currentmodule:: pandas.io.parsers

.. autosummary::
:toctree: generated/

read_table
read_csv
read_fwf

.. currentmodule:: pandas.io.clipboard

.. autosummary::
:toctree: generated/

read_clipboard

.. currentmodule:: pandas.io.excel

.. autosummary::
:toctree: generated/

read_excel
ExcelFile.parse

.. currentmodule:: pandas.io.json

.. autosummary::
:toctree: generated/

read_json

.. currentmodule:: pandas.io.html

.. autosummary::
:toctree: generated/

read_html

.. currentmodule:: pandas.io.pytables

.. autosummary::
:toctree: generated/

read_hdf
HDFStore.put
HDFStore.append
HDFStore.get
HDFStore.select

.. currentmodule:: pandas.io.sql

.. autosummary::
:toctree: generated/

read_sql
read_frame
write_frame

.. currentmodule:: pandas.io.stata

.. autosummary::
:toctree: generated/

read_stata
StataReader.data
StataReader.data_label
StataReader.value_labels
StataReader.variable_labels
StataWriter.write_file

.. currentmodule:: pandas.tools.pivot

.. autosummary::
:toctree: generated/

pivot_table

.. currentmodule:: pandas.tools.merge

.. autosummary::
:toctree: generated/

merge
concat

.. currentmodule:: pandas.core.reshape

.. autosummary::
:toctree: generated/

get_dummies

.. currentmodule:: pandas.core.common

.. autosummary::
:toctree: generated/

isnull
notnull

.. currentmodule:: pandas.tseries.tools

.. autosummary::
:toctree: generated/

to_datetime


.. currentmodule:: pandas.stats.moments

.. autosummary::
:toctree: generated/

rolling_count
rolling_sum
rolling_mean
rolling_median
rolling_var
rolling_std
rolling_corr
rolling_cov
rolling_skew
rolling_kurt
rolling_apply
rolling_quantile


.. currentmodule:: pandas.stats.moments

.. autosummary::
:toctree: generated/

expanding_count
expanding_sum
expanding_mean
expanding_median
expanding_var
expanding_std
expanding_corr
expanding_cov
expanding_skew
expanding_kurt
expanding_apply
expanding_quantile


.. autosummary::
:toctree: generated/

ewma
ewmstd
ewmvar
ewmcorr
ewmcov
25 changes: 24 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,30 @@

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}

# Add redirect for previously existing API pages (which are now included in
# the API pages as top-level functions) based on a template (GH9911)
moved_api_pages = [
'pandas.core.common.isnull', 'pandas.core.common.notnull', 'pandas.core.reshape.get_dummies',
'pandas.tools.merge.concat', 'pandas.tools.merge.merge', 'pandas.tools.pivot.pivot_table',
'pandas.tseries.tools.to_datetime', 'pandas.io.clipboard.read_clipboard', 'pandas.io.excel.ExcelFile.parse',
'pandas.io.excel.read_excel', 'pandas.io.html.read_html', 'pandas.io.json.read_json',
'pandas.io.parsers.read_csv', 'pandas.io.parsers.read_fwf', 'pandas.io.parsers.read_table',
'pandas.io.pickle.read_pickle', 'pandas.io.pytables.HDFStore.append', 'pandas.io.pytables.HDFStore.get',
'pandas.io.pytables.HDFStore.put', 'pandas.io.pytables.HDFStore.select', 'pandas.io.pytables.read_hdf',
'pandas.io.sql.read_sql', 'pandas.io.sql.read_frame', 'pandas.io.sql.write_frame',
'pandas.io.stata.read_stata', 'pandas.stats.moments.ewma', 'pandas.stats.moments.ewmcorr',
'pandas.stats.moments.ewmcov', 'pandas.stats.moments.ewmstd', 'pandas.stats.moments.ewmvar',
'pandas.stats.moments.expanding_apply', 'pandas.stats.moments.expanding_corr', 'pandas.stats.moments.expanding_count',
'pandas.stats.moments.expanding_cov', 'pandas.stats.moments.expanding_kurt', 'pandas.stats.moments.expanding_mean',
'pandas.stats.moments.expanding_median', 'pandas.stats.moments.expanding_quantile', 'pandas.stats.moments.expanding_skew',
'pandas.stats.moments.expanding_std', 'pandas.stats.moments.expanding_sum', 'pandas.stats.moments.expanding_var',
'pandas.stats.moments.rolling_apply', 'pandas.stats.moments.rolling_corr', 'pandas.stats.moments.rolling_count',
'pandas.stats.moments.rolling_cov', 'pandas.stats.moments.rolling_kurt', 'pandas.stats.moments.rolling_mean',
'pandas.stats.moments.rolling_median', 'pandas.stats.moments.rolling_quantile', 'pandas.stats.moments.rolling_skew',
'pandas.stats.moments.rolling_std', 'pandas.stats.moments.rolling_sum', 'pandas.stats.moments.rolling_var']

html_additional_pages = {'generated/' + page: 'api_redirect.html' for page in moved_api_pages}

# If false, no module index is generated.
html_use_modindex = True
Expand Down