Skip to content

DOC: Use official numpydoc extension #24098

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 11 commits into from
Dec 15, 2018
Merged

DOC: Use official numpydoc extension #24098

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
35da314
Use official numpydoc package
FHaase Dec 4, 2018
beae97d
Merge branch 'master' into numpydoc-disable-blockquotes
FHaase Dec 4, 2018
dd81ffb
Add numpydoc package to travis
FHaase Dec 4, 2018
b39f68e
Use member listing for attributes
FHaase Dec 4, 2018
979abca
Merge branch 'master' into numpydoc-disable-blockquotes
FHaase Dec 4, 2018
6b9b084
Move modification of SphinxDocString to conf.py
FHaase Dec 5, 2018
7a73034
Update comments to be more descriptive
FHaase Dec 5, 2018
cc25557
Fix linting
FHaase Dec 6, 2018
ec86647
Review of @jorisvandenbossche
FHaase Dec 11, 2018
62847f9
Fix linting
FHaase Dec 11, 2018
afeb025
Merge branch 'master' into numpydoc-disable-blockquotes
Dec 14, 2018
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
1 change: 1 addition & 0 deletions ci/deps/travis-36-doc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ dependencies:
- notebook
- numexpr
- numpy=1.13*
- numpydoc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we have a min version required?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know exactly. Currently it uses the latest which is 0.8.0.

- openpyxl
- pandoc
- pyarrow
Expand Down
8 changes: 1 addition & 7 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
'sphinx.ext.doctest',
'sphinx.ext.extlinks',
'sphinx.ext.todo',
'numpydoc',
'numpydoc_pandas', # use member listing for attributes
'IPython.sphinxext.ipython_directive',
'IPython.sphinxext.ipython_console_highlighting',
'matplotlib.sphinxext.plot_directive',
Expand Down Expand Up @@ -102,12 +102,6 @@
if any(re.match(r"\s*api\s*", l) for l in index_rst_lines):
autosummary_generate = True

# numpydoc
# for now use old parameter listing (styling + **kwargs problem)
numpydoc_use_blockquotes = True
# use member listing for attributes
numpydoc_attributes_as_param_list = False

# matplotlib plot directive
plot_include_source = True
plot_formats = [("png", 90)]
Expand Down
94 changes: 0 additions & 94 deletions doc/sphinxext/numpydoc/LICENSE.txt
View file
Open in desktop

This file was deleted.

51 changes: 0 additions & 51 deletions doc/sphinxext/numpydoc/README.rst
View file
Open in desktop

This file was deleted.

Loading