Skip to content

Commit c0410fd

Browse files
Merge pull request #11184 from jorisvandenbossche/doc-fixes4
DOC: fix bunch of doc build warnings
2 parents 38ee8c7 + a594dc1 commit c0410fd

9 files changed

+14
-15
lines changed

doc/source/basics.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1090,7 +1090,7 @@ decreasing.
10901090

10911091
Note that the same result could have been achieved using
10921092
:ref:`fillna <missing_data.fillna>` (except for ``method='nearest'``) or
1093-
:ref:`interpolate <missing_data.interpolation>`:
1093+
:ref:`interpolate <missing_data.interpolate>`:
10941094

10951095
.. ipython:: python
10961096

doc/source/comparison_with_sas.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Data Structures
3434
---------------
3535

3636
General Terminology Translation
37-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3838

3939
.. csv-table::
4040
:header: "pandas", "SAS"

doc/source/contributing.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ Creating a Development Environment
154154

155155
An easy way to create a *pandas* development environment is as follows.
156156

157-
- Install either :ref:`Install Anaconda <install-anaconda>` or :ref:`Install miniconda <install-miniconda>`
158-
- Make sure that you have :ref:`cloned the repository <contributing-forking>`
157+
- Install either :ref:`Install Anaconda <install.anaconda>` or :ref:`Install miniconda <install.miniconda>`
158+
- Make sure that you have :ref:`cloned the repository <contributing.forking>`
159159
- ``cd`` to the pandas source directory
160160

161161
Tell ``conda`` to create a new environment, named ``pandas_dev``, or any name you would like for this environment by running:
@@ -339,7 +339,7 @@ follow the Numpy Docstring Standard (see above), but you don't need to install
339339
this because a local copy of ``numpydoc`` is included in the *pandas* source
340340
code.
341341

342-
It is easiest to :ref:`create a development environment <contributing-dev_env>`, then install:
342+
It is easiest to :ref:`create a development environment <contributing.dev_env>`, then install:
343343

344344
::
345345

@@ -567,7 +567,7 @@ It is also useful to run tests in your current environment. You can simply do it
567567

568568
which would be equivalent to ``asv run --quick --show-stderr --python=same``. This
569569
will launch every test only once, display stderr from the benchmarks and use your
570-
local ``python'' that comes from your $PATH.
570+
local ``python`` that comes from your $PATH.
571571

572572
Information on how to write a benchmark can be found in
573573
`*asv*'s documentation http://asv.readthedocs.org/en/latest/writing_benchmarks.html`.

doc/source/install.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ To install pandas for Python 3 you may need to use the package ``python3-pandas`
179179
Installing from source
180180
~~~~~~~~~~~~~~~~~~~~~~
181181

182-
See the :ref:`contributing documentation <contributing>` for complete instructions on building from the git source tree. Further, see :ref:`creating a devevlopment environment <contributing-dev_env>` if you wish to create a *pandas* development environment.
182+
See the :ref:`contributing documentation <contributing>` for complete instructions on building from the git source tree. Further, see :ref:`creating a development environment <contributing.dev_env>` if you wish to create a *pandas* development environment.
183183

184184
Running the test suite
185185
~~~~~~~~~~~~~~~~~~~~~~

doc/source/io.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2075,11 +2075,11 @@ Equivalent class and function approaches to read multiple sheets:
20752075
# For when Sheet1's format is identical to Sheet2
20762076
data = read_excel('path_to_file.xls', ['Sheet1','Sheet2'], index_col=None, na_values=['NA'])
20772077
2078+
.. _io.excel.specifying_sheets:
2079+
20782080
Specifying Sheets
20792081
+++++++++++++++++
20802082

2081-
.. _io.specifying_sheets:
2082-
20832083
.. note :: The second argument is ``sheetname``, not to be confused with ``ExcelFile.sheet_names``
20842084
20852085
.. note :: An ExcelFile's attribute ``sheet_names`` provides access to a list of sheets.
@@ -3924,7 +3924,7 @@ For more information see the examples the SQLAlchemy `documentation <http://docs
39243924

39253925

39263926
Advanced SQLAlchemy queries
3927-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
3927+
'''''''''''''''''''''''''''
39283928

39293929
You can use SQLAlchemy constructs to describe your query.
39303930

doc/source/timeseries.rst

-1
Original file line numberDiff line numberDiff line change
@@ -1768,7 +1768,6 @@ TZ aware Dtypes
17681768
s_aware
17691769
17701770
Both of these ``Series`` can be manipulated via the ``.dt`` accessor, see :ref:`here <basics.dt_accessors>`.
1771-
See the :ref:`docs <timeseries.dtypes>` for more details.
17721771

17731772
For example, to localize and convert a naive stamp to timezone aware.
17741773

doc/source/whatsnew/v0.16.0.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Other enhancements
179179

180180
This method is also exposed by the lower level ``Index.get_indexer`` and ``Index.get_loc`` methods.
181181

182-
- The ``read_excel()`` function's :ref:`sheetname <_io.specifying_sheets>` argument now accepts a list and ``None``, to get multiple or all sheets respectively. If more than one sheet is specified, a dictionary is returned. (:issue:`9450`)
182+
- The ``read_excel()`` function's :ref:`sheetname <io.excel.specifying_sheets>` argument now accepts a list and ``None``, to get multiple or all sheets respectively. If more than one sheet is specified, a dictionary is returned. (:issue:`9450`)
183183

184184
.. code-block:: python
185185

doc/source/whatsnew/v0.16.1.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ values NOT in the categories, similarly to how you can reindex ANY pandas index.
9797
df2.reindex(pd.Categorical(['a','e'],categories=list('abcde')))
9898
df2.reindex(pd.Categorical(['a','e'],categories=list('abcde'))).index
9999

100-
See the :ref:`documentation <advanced.categoricalindex>` for more. (:issue:`7629`, :issue:`10038`, :issue:`10039`)
100+
See the :ref:`documentation <indexing.categoricalindex>` for more. (:issue:`7629`, :issue:`10038`, :issue:`10039`)
101101

102102
.. _whatsnew_0161.enhancements.sample:
103103

doc/source/whatsnew/v0.17.0.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ Other enhancements
453453

454454
- Enable reading gzip compressed files via URL, either by explicitly setting the compression parameter or by inferring from the presence of the HTTP Content-Encoding header in the response (:issue:`8685`)
455455

456-
- Enable writing Excel files in :ref:`memory <_io.excel_writing_buffer>` using StringIO/BytesIO (:issue:`7074`)
456+
- Enable writing Excel files in :ref:`memory <io.excel_writing_buffer>` using StringIO/BytesIO (:issue:`7074`)
457457

458458
- Enable serialization of lists and dicts to strings in ``ExcelWriter`` (:issue:`8188`)
459459

@@ -984,7 +984,7 @@ Deprecations
984984
``DataFrame.add(other, fill_value=0)`` and ``DataFrame.mul(other, fill_value=1.)``
985985
(:issue:`10735`).
986986
- ``TimeSeries`` deprecated in favor of ``Series`` (note that this has been alias since 0.13.0), (:issue:`10890`)
987-
- ``SparsePanel`` deprecated and will be removed in a future version (:issue:``)
987+
- ``SparsePanel`` deprecated and will be removed in a future version (:issue:`11157`).
988988
- ``Series.is_time_series`` deprecated in favor of ``Series.index.is_all_dates`` (:issue:`11135`)
989989
- Legacy offsets (like ``'A@JAN'``) listed in :ref:`here <timeseries.legacyaliases>` are deprecated (note that this has been alias since 0.8.0), (:issue:`10878`)
990990
- ``WidePanel`` deprecated in favor of ``Panel``, ``LongPanel`` in favor of ``DataFrame`` (note these have been aliases since < 0.11.0), (:issue:`10892`)

0 commit comments

Comments
 (0)