Skip to content

DOC: Adding header to the rst files that don't have it #24191

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 3 commits into from
Dec 10, 2018
Merged

DOC: Adding header to the rst files that don't have it #24191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e794715
DOC: Adding header to the rst files that don't have it
datapythonista Dec 10, 2018
51cc6db
Merge remote-tracking branch 'upstream/master' into rst_header
datapythonista Dec 10, 2018
edae762
making the current module pandas by default, as it's been moved to th…
datapythonista Dec 10, 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
3 changes: 2 additions & 1 deletion doc/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. currentmodule:: pandas
.. _api:

{{ header }}

*************
API Reference
*************
Expand Down
6 changes: 2 additions & 4 deletions doc/source/contributing_docstring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
.. _docstring:

{{ header }}

======================
pandas docstring guide
======================

.. note::
`Video tutorial: Pandas docstring guide
<https://www.youtube.com/watch?v=EOA0lUeW4NI>`_ by Frank Akogun.

About docstrings and standards
------------------------------

Expand Down
2 changes: 2 additions & 0 deletions doc/source/developer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _developer:

{{ header }}

.. currentmodule:: pandas

*********
Expand Down
2 changes: 2 additions & 0 deletions doc/source/ecosystem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _ecosystem:

{{ header }}

****************
pandas Ecosystem
****************
Expand Down
2 changes: 2 additions & 0 deletions doc/source/extending.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _extending:

{{ header }}

****************
Extending Pandas
****************
Expand Down
9 changes: 1 addition & 8 deletions doc/source/options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
.. _options:

.. currentmodule:: pandas

.. ipython:: python
:suppress:

import pandas as pd
import numpy as np
np.random.seed(123456)
{{ header }}

********************
Options and Settings
Expand Down
2 changes: 1 addition & 1 deletion doc/source/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _overview:

.. currentmodule:: pandas
{{ header }}

****************
Package overview
Expand Down
1 change: 0 additions & 1 deletion doc/source/r_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

{{ header }}


******************
rpy2 / R interface
******************
Expand Down
2 changes: 2 additions & 0 deletions doc/source/releases.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _release:

{{ header }}

*************
Release Notes
*************
Expand Down
2 changes: 2 additions & 0 deletions doc/source/tutorials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _tutorials:

{{ header }}

*********
Tutorials
*********
Expand Down
1 change: 1 addition & 0 deletions scripts/validate_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ def get_api_items(api_doc_fd):
The name of the subsection in the API page where the object item is
located.
"""
current_module = 'pandas'
previous_line = current_section = current_subsection = ''
position = None
for line in api_doc_fd:
Expand Down