Skip to content

DOC: add explanation to doc/sphinxext #6441

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
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
'sphinx.ext.extlinks',
'sphinx.ext.todo',
'numpydoc', # used to parse numpy-style docstrings for autodoc
'ipython_directive',
'ipython_console_highlighting',
'ipython_sphinxext.ipython_directive',
'ipython_sphinxext.ipython_console_highlighting',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
Expand Down
17 changes: 17 additions & 0 deletions doc/sphinxext/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
sphinxext
=========

This directory contains copies of different sphinx extensions in use in the
pandas documentation. These copies originate from other projects:

- ``numpydoc`` - Numpy's Sphinx extensions: this can be found at its own
repository: https://github.com/numpy/numpydoc
- ``ipython_directive`` and ``ipython_console_highlighting`` in the folder
`ipython_sphinxext` - Sphinx extensions from IPython: these are included
in IPython: https://github.com/ipython/ipython/tree/master/IPython/sphinxext

.. note::

These copies are maintained at the respective projects, so fixes should,
to the extent possible, be pushed upstream instead of only adapting our
local copy to avoid divergence between the the local and upstream version.
Empty file.