Skip to content

Commit bf4786a

Browse files
DOC: various doc build fixes (#13502)
* DOC: fix indentation error in nth docstring * DOC: suppress warning for deprecated matplotlib style * DOC: fix code block directive * DOC: fix duplicate explicit target name * DOC: fix malformed hyperlink target * DOC: use valid header symbols * DOC: fix interlinking to scipy * DOC: fix link to python docs on range
1 parent ab116a7 commit bf4786a

File tree

8 files changed

+12
-10
lines changed

8 files changed

+12
-10
lines changed

doc/source/advanced.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -729,7 +729,7 @@ Int64Index and RangeIndex
729729
Prior to 0.18.0, the ``Int64Index`` would provide the default index for all ``NDFrame`` objects.
730730
731731
``RangeIndex`` is a sub-class of ``Int64Index`` added in version 0.18.0, now providing the default index for all ``NDFrame`` objects.
732-
``RangeIndex`` is an optimized version of ``Int64Index`` that can represent a monotonic ordered set. These are analagous to python :ref:`range types <https://docs.python.org/3/library/stdtypes.html#typesseq-range>`.
732+
``RangeIndex`` is an optimized version of ``Int64Index`` that can represent a monotonic ordered set. These are analagous to python `range types <https://docs.python.org/3/library/stdtypes.html#typesseq-range>`__.
733733
734734
.. _indexing.float64index:
735735

doc/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@
292292
'matplotlib': ('http://matplotlib.org/', None),
293293
'python': ('http://docs.python.org/3', None),
294294
'numpy': ('http://docs.scipy.org/doc/numpy', None),
295-
'scipy': ('http://docs.scipy.org/doc/scipy', None),
295+
'scipy': ('http://docs.scipy.org/doc/scipy/reference', None),
296296
'py': ('http://pylib.readthedocs.org/en/latest/', None)
297297
}
298298
import glob

doc/source/io.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4789,7 +4789,7 @@ Reading
47894789
47904790
Space on disk (in bytes)
47914791

4792-
.. code-block::
4792+
.. code-block:: none
47934793
47944794
25843712 Apr 8 14:11 test.sql
47954795
24007368 Apr 8 14:11 test_fixed.hdf

doc/source/options.rst

+1
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ with no argument ``describe_option`` will print out the descriptions for all ava
7171

7272
.. ipython:: python
7373
:suppress:
74+
:okwarning:
7475
7576
pd.reset_option("all")
7677

doc/source/r_interface.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ rpy2 / R interface
1717

1818
In v0.16.0, the ``pandas.rpy`` interface has been **deprecated and will be
1919
removed in a future version**. Similar functionality can be accessed
20-
through the `rpy2 <http://rpy2.readthedocs.io/>`_ project.
20+
through the `rpy2 <http://rpy2.readthedocs.io/>`__ project.
2121
See the :ref:`updating <rpy.updating>` section for a guide to port your
2222
code from the ``pandas.rpy`` to ``rpy2`` functions.
2323

@@ -73,7 +73,7 @@ The ``convert_to_r_matrix`` function can be replaced by the normal
7373
comparison to the ones in pandas, please report this at the
7474
`issue tracker <https://github.com/pydata/pandas/issues>`_.
7575

76-
See also the documentation of the `rpy2 <http://rpy.sourceforge.net/>`_ project.
76+
See also the documentation of the `rpy2 <http://rpy.sourceforge.net/>`__ project.
7777

7878

7979
R interface with rpy2

doc/source/whatsnew/v0.18.0.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,7 @@ yields a ``Resampler``.
764764
r
765765

766766
Downsampling
767-
''''''''''''
767+
""""""""""""
768768

769769
You can then use this object to perform operations.
770770
These are downsampling operations (going from a higher frequency to a lower one).
@@ -796,7 +796,7 @@ These accessors can of course, be combined
796796
r[['A','B']].agg(['mean','sum'])
797797

798798
Upsampling
799-
''''''''''
799+
""""""""""
800800

801801
.. currentmodule:: pandas.tseries.resample
802802

@@ -842,7 +842,7 @@ New API
842842
In the new API, you can either downsample OR upsample. The prior implementation would allow you to pass an aggregator function (like ``mean``) even though you were upsampling, providing a bit of confusion.
843843

844844
Previous API will work but with deprecations
845-
''''''''''''''''''''''''''''''''''''''''''''
845+
""""""""""""""""""""""""""""""""""""""""""""
846846

847847
.. warning::
848848

doc/source/whatsnew/v0.18.1.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ New Behavior:
374374
df.groupby('c', sort=False).nth(1)
375375

376376

377-
.. _whatsnew_0181.numpy_compatibility
377+
.. _whatsnew_0181.numpy_compatibility:
378378

379379
numpy function compatibility
380380
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

pandas/core/groupby.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -1197,7 +1197,8 @@ def nth(self, n, dropna=None):
11971197
1 4
11981198
5 6
11991199
1200-
# NaNs denote group exhausted when using dropna
1200+
NaNs denote group exhausted when using dropna
1201+
12011202
>>> g.nth(1, dropna='any')
12021203
B
12031204
A

0 commit comments

Comments
 (0)