From 9082e7fccf790f61a3f7f9e97309fa9ec6cdb33b Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Tue, 18 Jan 2022 12:44:24 -0800 Subject: [PATCH 1/2] CI/DOC: Fix docbuild link warnings --- doc/source/user_guide/advanced.rst | 2 +- doc/source/user_guide/cookbook.rst | 21 +++++++-------------- doc/source/whatsnew/v0.17.1.rst | 4 +--- 3 files changed, 9 insertions(+), 18 deletions(-) diff --git a/doc/source/user_guide/advanced.rst b/doc/source/user_guide/advanced.rst index 6b3f92b942c8c..b8df21ab5a5b4 100644 --- a/doc/source/user_guide/advanced.rst +++ b/doc/source/user_guide/advanced.rst @@ -1246,5 +1246,5 @@ This is because the (re)indexing operations above silently inserts ``NaNs`` and changes accordingly. This can cause some issues when using ``numpy`` ``ufuncs`` such as ``numpy.logical_and``. -See the `this old issue `__ for a more +See the :issue:`2388` for a more detailed discussion. diff --git a/doc/source/user_guide/cookbook.rst b/doc/source/user_guide/cookbook.rst index 4d055eac34f78..f88f4a9708c45 100644 --- a/doc/source/user_guide/cookbook.rst +++ b/doc/source/user_guide/cookbook.rst @@ -193,8 +193,7 @@ The :ref:`indexing ` docs. df[(df.AAA <= 6) & (df.index.isin([0, 2, 4]))] -`Use loc for label-oriented slicing and iloc positional slicing -`__ +Use loc for label-oriented slicing and iloc positional slicing :issue:`2904` .. ipython:: python @@ -395,8 +394,7 @@ Sorting df.sort_values(by=("Labs", "II"), ascending=False) -`Partial selection, the need for sortedness; -`__ +Partial selection, the need for sortedness :issue:`2995` Levels ****** @@ -910,8 +908,7 @@ Valid frequency arguments to Grouper :ref:`Timeseries `__ -`Using TimeGrouper and another grouping to create subgroups, then apply a custom function -`__ +Using TimeGrouper and another grouping to create subgroups, then apply a custom function :issue:`3791` `Resampling with custom periods `__ @@ -947,8 +944,7 @@ Depending on df construction, ``ignore_index`` may be needed df = pd.concat([df1, df2], ignore_index=True) df -`Self Join of a DataFrame -`__ +Self Join of a DataFrame :issue:`2996` .. ipython:: python @@ -1070,8 +1066,7 @@ using that handle to read. `Inferring dtypes from a file `__ -`Dealing with bad lines -`__ +Dealing with bad lines :issue:`2886` `Write a multi-row index CSV without writing duplicates `__ @@ -1205,8 +1200,7 @@ The :ref:`Excel ` docs `Modifying formatting in XlsxWriter output `__ -`Loading only visible sheets -`__ +Loading only visible sheets :issue:`19842#issuecomment-892150745` .. _cookbook.html: @@ -1226,8 +1220,7 @@ The :ref:`HDFStores ` docs `Simple queries with a Timestamp Index `__ -`Managing heterogeneous data using a linked multiple table hierarchy -`__ +Managing heterogeneous data using a linked multiple table hierarchy :issue:`3032` `Merging on-disk tables with millions of rows `__ diff --git a/doc/source/whatsnew/v0.17.1.rst b/doc/source/whatsnew/v0.17.1.rst index 6b0a28ec47568..774d17e6ff6b0 100644 --- a/doc/source/whatsnew/v0.17.1.rst +++ b/doc/source/whatsnew/v0.17.1.rst @@ -37,9 +37,7 @@ Conditional HTML formatting .. warning:: This is a new feature and is under active development. We'll be adding features an possibly making breaking changes in future - releases. Feedback is welcome_. - -.. _welcome: https://github.com/pandas-dev/pandas/issues/11610 + releases. Feedback is welcome in :issue:`11610` We've added *experimental* support for conditional HTML formatting: the visual styling of a DataFrame based on the data. From b78d67d9a5fa2fc361892f64c454515d0e204bd2 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Tue, 18 Jan 2022 13:34:18 -0800 Subject: [PATCH 2/2] Fix more GH links --- doc/source/development/contributing_codebase.rst | 3 +-- doc/source/development/roadmap.rst | 6 ++---- doc/source/ecosystem.rst | 3 +-- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index d3e48ba0deaee..4826921d4866b 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -490,8 +490,7 @@ Writing tests All tests should go into the ``tests`` subdirectory of the specific package. This folder contains many current examples of tests, and we suggest looking to these for inspiration. If your test requires working with files or -network connectivity, there is more information on the `testing page -`_ of the wiki. +network connectivity, there is more information on the :wiki:`Testing` of the wiki. The ``pandas._testing`` module has many special ``assert`` functions that make it easier to make statements about whether Series or DataFrame objects are diff --git a/doc/source/development/roadmap.rst b/doc/source/development/roadmap.rst index 1b6427790622c..ccdb4f1fafae4 100644 --- a/doc/source/development/roadmap.rst +++ b/doc/source/development/roadmap.rst @@ -74,8 +74,7 @@ types. This includes consistent behavior in all operations (indexing, arithmetic operations, comparisons, etc.). There has been discussion of eventually making the new semantics the default. -This has been discussed at -`github #28095 `__ (and +This has been discussed at :issue:`28095` (and linked issues), and described in more detail in this `design doc `__. @@ -129,8 +128,7 @@ We propose that it should only work with positional indexing, and the translatio to positions should be entirely done at a higher level. Indexing is a complicated API with many subtleties. This refactor will require care -and attention. More details are discussed at -https://github.com/pandas-dev/pandas/wiki/(Tentative)-rules-for-restructuring-indexing-code +and attention. More details are discussed at :wiki:`(Tentative)-rules-for-restructuring-indexing-code` Numba-accelerated operations ---------------------------- diff --git a/doc/source/ecosystem.rst b/doc/source/ecosystem.rst index 6ac08e6d82cbc..16cae9bbfbf46 100644 --- a/doc/source/ecosystem.rst +++ b/doc/source/ecosystem.rst @@ -586,7 +586,6 @@ Development tools While pandas repository is partially typed, the package itself doesn't expose this information for external use. Install pandas-stubs to enable basic type coverage of pandas API. -Learn more by reading through these issues `14468 `_, -`26766 `_, `28142 `_. +Learn more by reading through :issue:`14468`, :issue:`26766`, :issue:`28142`. See installation and usage instructions on the `github page `__.