From e7947159e51507b1160080a2dfc942e9c34d13e9 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Mon, 10 Dec 2018 01:48:00 +0000 Subject: [PATCH 1/2] DOC: Adding header to the rst files that don't have it --- doc/source/api.rst | 3 ++- doc/source/contributing_docstring.rst | 6 ++---- doc/source/developer.rst | 2 ++ doc/source/ecosystem.rst | 2 ++ doc/source/extending.rst | 2 ++ doc/source/options.rst | 9 +-------- doc/source/overview.rst | 2 +- doc/source/r_interface.rst | 1 - doc/source/releases.rst | 2 ++ doc/source/tutorials.rst | 2 ++ 10 files changed, 16 insertions(+), 15 deletions(-) diff --git a/doc/source/api.rst b/doc/source/api.rst index 49c89a53e7b17..bcef5567c23e5 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -1,6 +1,7 @@ -.. currentmodule:: pandas .. _api: +{{ header }} + ************* API Reference ************* diff --git a/doc/source/contributing_docstring.rst b/doc/source/contributing_docstring.rst index 2f8ffc2e07c71..7c7847a47a1a2 100644 --- a/doc/source/contributing_docstring.rst +++ b/doc/source/contributing_docstring.rst @@ -1,13 +1,11 @@ .. _docstring: +{{ header }} + ====================== pandas docstring guide ====================== -.. note:: - `Video tutorial: Pandas docstring guide - `_ by Frank Akogun. - About docstrings and standards ------------------------------ diff --git a/doc/source/developer.rst b/doc/source/developer.rst index ba6cec93d02e4..a283920ae4377 100644 --- a/doc/source/developer.rst +++ b/doc/source/developer.rst @@ -1,5 +1,7 @@ .. _developer: +{{ header }} + .. currentmodule:: pandas ********* diff --git a/doc/source/ecosystem.rst b/doc/source/ecosystem.rst index ad389bbe35b71..e0c47e2f2ba7e 100644 --- a/doc/source/ecosystem.rst +++ b/doc/source/ecosystem.rst @@ -1,5 +1,7 @@ .. _ecosystem: +{{ header }} + **************** pandas Ecosystem **************** diff --git a/doc/source/extending.rst b/doc/source/extending.rst index 472671ad22273..35d0dab7c3a77 100644 --- a/doc/source/extending.rst +++ b/doc/source/extending.rst @@ -1,5 +1,7 @@ .. _extending: +{{ header }} + **************** Extending Pandas **************** diff --git a/doc/source/options.rst b/doc/source/options.rst index dc4d0da32008c..31359c337fdb8 100644 --- a/doc/source/options.rst +++ b/doc/source/options.rst @@ -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 diff --git a/doc/source/overview.rst b/doc/source/overview.rst index b71f4bfa2f3be..351cc09c07cab 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -1,6 +1,6 @@ .. _overview: -.. currentmodule:: pandas +{{ header }} **************** Package overview diff --git a/doc/source/r_interface.rst b/doc/source/r_interface.rst index 4ec43a64cf98a..9839bba4884d4 100644 --- a/doc/source/r_interface.rst +++ b/doc/source/r_interface.rst @@ -2,7 +2,6 @@ {{ header }} - ****************** rpy2 / R interface ****************** diff --git a/doc/source/releases.rst b/doc/source/releases.rst index 0167903cce8bc..491569c69115b 100644 --- a/doc/source/releases.rst +++ b/doc/source/releases.rst @@ -1,5 +1,7 @@ .. _release: +{{ header }} + ************* Release Notes ************* diff --git a/doc/source/tutorials.rst b/doc/source/tutorials.rst index d5da7df347573..c07319fff777b 100644 --- a/doc/source/tutorials.rst +++ b/doc/source/tutorials.rst @@ -1,5 +1,7 @@ .. _tutorials: +{{ header }} + ********* Tutorials ********* From edae762fc3baa4c3f901ada2233236d30afef4e0 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Mon, 10 Dec 2018 12:45:40 +0000 Subject: [PATCH 2/2] making the current module pandas by default, as it's been moved to the header in api.rst, and it's not detected by the validation script --- scripts/validate_docstrings.py | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/validate_docstrings.py b/scripts/validate_docstrings.py index 0f553cc4f2fe8..ecb02071c5bb6 100755 --- a/scripts/validate_docstrings.py +++ b/scripts/validate_docstrings.py @@ -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: