Regenerate html

kynan · kynan · commit 1bfe28bf6211 · 2018-03-10T21:26:38.000Z
diff --git a/pandas/guide/_sources/pandas_docstring.rst.txt b/pandas/guide/_sources/pandas_docstring.rst.txt
@@ -4,6 +4,10 @@
 pandas docstring guide
 ======================
 
+.. note::
+  `Video tutorial: Pandas docstring guide
+  <https://www.youtube.com/watch?v=EOA0lUeW4NI>`_ by Frank Akogun.
+
 About docstrings and standards
 ------------------------------
 
diff --git a/pandas/guide/_sources/pandas_pr.rst.txt b/pandas/guide/_sources/pandas_pr.rst.txt
@@ -4,6 +4,10 @@
 Submitting your changes
 =======================
 
+.. note::
+  `Video tutorial: Submitting docstring changes to GitHub
+  <https://www.youtube.com/watch?v=7eC3MjDIxNM>`_ by Frank Akogun.
+
 Once you finished the changes to your assigned docstring, you can follow the
 instructions in this document in order to get your changes merged into pandas,
 and released in the next version.
diff --git a/pandas/guide/organizers.html b/pandas/guide/organizers.html
@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Information for organizers &#8212; Python  documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    './',
-        VERSION:     '',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="_static/documentation_options.js"></script>
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
@@ -29,8 +21,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
-  </head>
-  <body>
+  </head><body>
   
 
     <div class="document">
@@ -273,12 +264,14 @@ <h3>This Page</h3>
    </div>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
+    <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
       <input type="hidden" name="check_keywords" value="yes" />
       <input type="hidden" name="area" value="default" />
     </form>
+    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -289,7 +282,7 @@ <h3>Quick search</h3>
       &copy;.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
diff --git a/pandas/guide/pandas_docstring.html b/pandas/guide/pandas_docstring.html
@@ -33,6 +33,10 @@
             
   <div class="section" id="pandas-docstring-guide">
 <span id="docstring"></span><h1>pandas docstring guide<a class="headerlink" href="#pandas-docstring-guide" title="Permalink to this headline">¶</a></h1>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last"><a class="reference external" href="https://www.youtube.com/watch?v=EOA0lUeW4NI">Video tutorial: Pandas docstring guide</a> by Frank Akogun.</p>
+</div>
 <div class="section" id="about-docstrings-and-standards">
 <h2>About docstrings and standards<a class="headerlink" href="#about-docstrings-and-standards" title="Permalink to this headline">¶</a></h2>
 <p>A Python docstring is a string used to document a Python module, class,
diff --git a/pandas/guide/pandas_pr.html b/pandas/guide/pandas_pr.html
@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Submitting your changes &#8212; Python  documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    './',
-        VERSION:     '',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="_static/documentation_options.js"></script>
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
@@ -30,8 +22,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
-  </head>
-  <body>
+  </head><body>
   
 
     <div class="document">
@@ -41,6 +32,10 @@
             
   <div class="section" id="submitting-your-changes">
 <span id="pandas-pr"></span><h1>Submitting your changes<a class="headerlink" href="#submitting-your-changes" title="Permalink to this headline">¶</a></h1>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last"><a class="reference external" href="https://www.youtube.com/watch?v=7eC3MjDIxNM">Video tutorial: Submitting docstring changes to GitHub</a> by Frank Akogun.</p>
+</div>
 <p>Once you finished the changes to your assigned docstring, you can follow the
 instructions in this document in order to get your changes merged into pandas,
 and released in the next version.</p>
@@ -49,12 +44,12 @@ <h2>1. Validate that your docstring does not have technical errors<a class="head
 <p>There is a script in pandas that validates whether a docstring follows the
 technical parts of the pandas docstring convention. To run the script,
 execute in your terminal:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">&lt;</span><span class="n">pandas</span><span class="o">-</span><span class="nb">dir</span><span class="o">&gt;</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">&lt;</span><span class="n">pandas</span><span class="o">-</span><span class="nb">dir</span><span class="o">&gt;</span>
 <span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">validate_docstrings</span><span class="o">.</span><span class="n">py</span> <span class="o">&lt;</span><span class="n">your</span><span class="o">-</span><span class="n">function</span><span class="o">-</span><span class="ow">or</span><span class="o">-</span><span class="n">method</span><span class="o">&gt;</span>
 </pre></div>
 </div>
-<p>where <code class="docutils literal"><span class="pre">&lt;your-function-or-method&gt;</span></code> is for example <code class="docutils literal"><span class="pre">pandas.DataFrame.head</span></code>,
-<code class="docutils literal"><span class="pre">pandas.Series.tail</span></code> or <code class="docutils literal"><span class="pre">pandas.to_datetime</span></code>.</p>
+<p>where <code class="docutils literal notranslate"><span class="pre">&lt;your-function-or-method&gt;</span></code> is for example <code class="docutils literal notranslate"><span class="pre">pandas.DataFrame.head</span></code>,
+<code class="docutils literal notranslate"><span class="pre">pandas.Series.tail</span></code> or <code class="docutils literal notranslate"><span class="pre">pandas.to_datetime</span></code>.</p>
 <p>The output of the script will show the final docstring. In many cases just a
 verbatim copy, but in some cases the docstring is implemented as a template,
 and reused by more than one method or function, and this is useful to see
@@ -64,12 +59,12 @@ <h2>1. Validate that your docstring does not have technical errors<a class="head
 missing dot at the end of a sentence, a blank line where it should not be, etc.</p>
 <p>Finally, the output will also contain errors from running the examples.</p>
 <p>With few exceptions, you should fix all the errors before continuing.</p>
-<p>If you are changing a docstring in a cython file (with <code class="docutils literal"><span class="pre">.pyx</span></code> extension),
+<p>If you are changing a docstring in a cython file (with <code class="docutils literal notranslate"><span class="pre">.pyx</span></code> extension),
 you need to rebuild the pandas C extensions to be able to see the resulting
 changes in the docstring and to validate the docstring with the command
 above.</p>
 <p>To recompile pandas, run:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">&lt;</span><span class="n">pandas</span><span class="o">-</span><span class="nb">dir</span><span class="o">&gt;</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">&lt;</span><span class="n">pandas</span><span class="o">-</span><span class="nb">dir</span><span class="o">&gt;</span>
 <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">build_ext</span> <span class="o">--</span><span class="n">inplace</span>
 </pre></div>
 </div>
@@ -82,14 +77,14 @@ <h2>2. Visual validation of the docstring<a class="headerlink" href="#visual-val
 them, as well as the visualization of your docstring in the pandas website
 you need to generate the html version of the page you worked on.</p>
 <p>To build the documentation run:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">&lt;</span><span class="n">pandas</span><span class="o">-</span><span class="nb">dir</span><span class="o">&gt;/</span><span class="n">doc</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">&lt;</span><span class="n">pandas</span><span class="o">-</span><span class="nb">dir</span><span class="o">&gt;/</span><span class="n">doc</span>
 <span class="n">python</span> <span class="n">make</span><span class="o">.</span><span class="n">py</span> <span class="n">html</span> <span class="o">--</span><span class="n">single</span> <span class="o">&lt;</span><span class="n">your</span><span class="o">-</span><span class="n">function</span><span class="o">-</span><span class="ow">or</span><span class="o">-</span><span class="n">method</span><span class="o">&gt;</span>
 </pre></div>
 </div>
-<p>where <code class="docutils literal"><span class="pre">&lt;your-function-or-method&gt;</span></code> follows the format described in the previous
+<p>where <code class="docutils literal notranslate"><span class="pre">&lt;your-function-or-method&gt;</span></code> follows the format described in the previous
 section.</p>
 <p>This will generate a file
-<code class="docutils literal"><span class="pre">&lt;pandas-dir&gt;/doc/build/html/generated_single/&lt;your-function-or-method&gt;.html</span></code>
+<code class="docutils literal notranslate"><span class="pre">&lt;pandas-dir&gt;/doc/build/html/generated_single/&lt;your-function-or-method&gt;.html</span></code>
 that can be opened with your web browser.</p>
 </div>
 <div class="section" id="validate-that-the-docstring-is-clear-to-others">
@@ -104,21 +99,21 @@ <h2>4. Commit your changes<a class="headerlink" href="#commit-your-changes" titl
 into git.</p>
 <p>Before committing your changes, make sure you are in the branch of the feature
 you are going to commit with:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">branch</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">branch</span>
 </pre></div>
 </div>
-<p>If the current branch is <code class="docutils literal"><span class="pre">master</span></code>, do not commit your changes, as you can get
+<p>If the current branch is <code class="docutils literal notranslate"><span class="pre">master</span></code>, do not commit your changes, as you can get
 into a situation where you need to undo your history in git, which is not
 straightforward.</p>
 <p>Then, get the latest upstream changes and commit your changes on top:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">fetch</span> <span class="n">upstream</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">fetch</span> <span class="n">upstream</span>
 <span class="n">git</span> <span class="n">merge</span> <span class="n">upstream</span><span class="o">/</span><span class="n">master</span>
 <span class="n">git</span> <span class="n">add</span> <span class="o">&lt;</span><span class="n">modified</span><span class="o">-</span><span class="n">file</span><span class="p">(</span><span class="n">s</span><span class="p">)</span><span class="o">&gt;</span>
 <span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">m</span> <span class="s2">&quot;&lt;commit-message&gt;&quot;</span>
 </pre></div>
 </div>
-<p>where <code class="docutils literal"><span class="pre">&lt;modified-file(s)&gt;</span></code> is the file where you made your changes (in rare
-cases it could be more than one file). And <code class="docutils literal"><span class="pre">&lt;commit-message&gt;</span></code> is a short
+<p>where <code class="docutils literal notranslate"><span class="pre">&lt;modified-file(s)&gt;</span></code> is the file where you made your changes (in rare
+cases it could be more than one file). And <code class="docutils literal notranslate"><span class="pre">&lt;commit-message&gt;</span></code> is a short
 description of your changes, starting by “DOC:” (e.g. “DOC: Improve the
 docstring of DataFrame.head()”).</p>
 </div>
@@ -128,7 +123,7 @@ <h2>5. Push your changes to pandas<a class="headerlink" href="#push-your-changes
 pandas maintainers, so they can add them to the main pandas repository.</p>
 <p>The first step is to push your local changes to your own fork, so they are
 available online:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">push</span> <span class="o">-</span><span class="n">u</span> <span class="n">origin</span> <span class="o">&lt;</span><span class="n">your</span><span class="o">-</span><span class="n">branch</span><span class="o">-</span><span class="n">name</span><span class="o">&gt;</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">push</span> <span class="o">-</span><span class="n">u</span> <span class="n">origin</span> <span class="o">&lt;</span><span class="n">your</span><span class="o">-</span><span class="n">branch</span><span class="o">-</span><span class="n">name</span><span class="o">&gt;</span>
 </pre></div>
 </div>
 <p>Then, visit <a class="reference external" href="https://github.com/pandas-dev/pandas">https://github.com/pandas-dev/pandas</a> in your browser, and click
@@ -142,12 +137,12 @@ <h2>5. Push your changes to pandas<a class="headerlink" href="#push-your-changes
 we do not need to add/run tests or add a <cite>whatsnew</cite> entry. So you can ignore
 these check boxes. Just verify that your changes respect the PEP-8 style by
 running the command:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">diff</span> <span class="n">upstream</span><span class="o">/</span><span class="n">master</span> <span class="o">-</span><span class="n">u</span> <span class="o">--</span> <span class="s2">&quot;*.py&quot;</span> <span class="o">|</span> <span class="n">flake8</span> <span class="o">--</span><span class="n">diff</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">diff</span> <span class="n">upstream</span><span class="o">/</span><span class="n">master</span> <span class="o">-</span><span class="n">u</span> <span class="o">--</span> <span class="s2">&quot;*.py&quot;</span> <span class="o">|</span> <span class="n">flake8</span> <span class="o">--</span><span class="n">diff</span>
 </pre></div>
 </div>
 <p>If you don’t already have flake8 installed, you can install it in the Anaconda
 Prompt it via</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">flake8</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">flake8</span>
 </pre></div>
 </div>
 <p>If the command does not return any warning, mark that checkbox with an X (do
@@ -165,9 +160,9 @@ <h3>Updating a pull request<a class="headerlink" href="#updating-a-pull-request"
 contributors.</p>
 <p>For comments in your review, you can make new changes in your local branch for
 that pull request. And once you addressed all the comments, you can commit them
-and push again to your local branch. As you used the parameter <code class="docutils literal"><span class="pre">-u</span></code> to set
+and push again to your local branch. As you used the parameter <code class="docutils literal notranslate"><span class="pre">-u</span></code> to set
 the upstream branch in your first push, you can simply run:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">push</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">push</span>
 </pre></div>
 </div>
 <p>from your local branch, and the changes will be pushed to your remote branch.</p>
@@ -227,12 +222,14 @@ <h3>This Page</h3>
    </div>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
+    <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
       <input type="hidden" name="check_keywords" value="yes" />
       <input type="hidden" name="area" value="default" />
     </form>
+    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -243,7 +240,7 @@ <h3>Quick search</h3>
       &copy;.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
diff --git a/pandas/guide/searchindex.js b/pandas/guide/searchindex.js
