Merge pull request #3961 from cpcloud/github-issue-sphinxext

DOC/CLN: remove gh links and use the new issue format for whatsnew

Author: cpcloud

CONTRIBUTING.md

@@ -71,10 +71,10 @@ your contribution or address the issue you're having.
 
     which fails on python 2.6, use `self.assertRaises(TheException,func,args)` instead.
 
-  - RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each
-    release as it is worked on. Add entries to these files as needed in
-    a separate commit in your PR, documenting the fix, enhancement or (unavoidable)
-    breaking change.
+  - doc/source/release.rst and doc/source/vx.y.z.txt contain an on-going
+    changelog for each release as it is worked on. Add entries to these files
+    as needed in a separate commit in your PR, documenting the fix, enhancement
+    or (unavoidable) breaking change.
   - For extra brownie points, use "git rebase -i" to squash and reorder
     commits in your PR so that the history makes the most sense. Use your own
     judgment to decide what history needs to be preserved.

RELEASE.md

@@ -0,0 +1,6 @@
+Release Notes
+=============
+
+The list of changes to pandas between each release can be found
+[here](http://pandas.pydata.org/pandas-docs/stable/release.html). For full
+details, see the commit logs at http://github.com/pydata/pandas.

RELEASE.rst

@@ -243,8 +243,6 @@
 
 # extlinks alias
 extlinks = {'issue': ('https://github.com/pydata/pandas/issues/%s',
-                      'issue '),
-            'pull request': ('https://github.com/pydata/pandas/pulls/%s',
-                             'pull request '),
-            'wiki': ('https://github.com/pydata/pandas/pulls/%s',
+                      'GH'),
+            'wiki': ('https://github.com/pydata/pandas/wiki/%s',
                      'wiki ')}

doc/source/conf.py

@@ -105,7 +105,6 @@ See the package overview for more detail about what's in the library.
 
 
 .. toctree::
-    :hidden:
     :maxdepth: 3
 
     whatsnew
@@ -132,4 +131,4 @@ See the package overview for more detail about what's in the library.
     related
     comparison_with_r
     api
-
+    release

doc/source/index.rst

@@ -159,7 +159,7 @@ Convenience methods ``ffill`` and  ``bfill`` have been added:
       s
       s.apply(f)
 
-- New API functions for working with pandas options (GH2097_):
+- New API functions for working with pandas options (:issue:`2097`):
 
   - ``get_option`` / ``set_option`` - get/set the value of an option. Partial
     names are accepted.  - ``reset_option`` - reset one or more options to
@@ -174,7 +174,7 @@ Convenience methods ``ffill`` and  ``bfill`` have been added:
 
      get_option("display.max_rows")
 
-- to_string() methods now always return unicode strings  (GH2224_).
+- to_string() methods now always return unicode strings  (:issue:`2224`).
 
 New features
 ~~~~~~~~~~~~
@@ -297,22 +297,22 @@ Updated PyTables Support
 
 - performance improvments on table writing
 - support for arbitrarily indexed dimensions
-- ``SparseSeries`` now has a ``density`` property (GH2384_)
+- ``SparseSeries`` now has a ``density`` property (:issue:`2384`)
 - enable ``Series.str.strip/lstrip/rstrip`` methods to take an input argument
-  to strip arbitrary characters (GH2411_)
+  to strip arbitrary characters (:issue:`2411`)
 - implement ``value_vars`` in ``melt`` to limit values to certain columns
-  and add ``melt`` to pandas namespace (GH2412_)
+  and add ``melt`` to pandas namespace (:issue:`2412`)
 
 **Bug Fixes**
 
-- added ``Term`` method of specifying where conditions (GH1996_).
+- added ``Term`` method of specifying where conditions (:issue:`1996`).
 - ``del store['df']`` now call ``store.remove('df')`` for store deletion
 - deleting of consecutive rows is much faster than before
 - ``min_itemsize`` parameter can be specified in table creation to force a
   minimum size for indexing columns (the previous implementation would set the
   column size based on the first append)
 - indexing support via ``create_table_index`` (requires PyTables >= 2.3)
-  (GH698_).
+  (:issue:`698`).
 - appending on a store would fail if the table was not first created via ``put``
 - fixed issue with missing attributes after loading a pickled dataframe (GH2431)
 - minor change to select and remove: require a table ONLY if where is also
@@ -350,16 +350,7 @@ Adding experimental support for Panel4D and factory functions to create n-dimens
 
 
 
-See the `full release notes
-<https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
+See the :ref:`full release notes
+<release>` or issue tracker
 on GitHub for a complete list.
 
-.. _GH698: https://github.com/pydata/pandas/issues/698
-.. _GH1996: https://github.com/pydata/pandas/issues/1996
-.. _GH2316: https://github.com/pydata/pandas/issues/2316
-.. _GH2097: https://github.com/pydata/pandas/issues/2097
-.. _GH2224: https://github.com/pydata/pandas/issues/2224
-.. _GH2431: https://github.com/pydata/pandas/issues/2431
-.. _GH2412: https://github.com/pydata/pandas/issues/2412
-.. _GH2411: https://github.com/pydata/pandas/issues/2411
-.. _GH2384: https://github.com/pydata/pandas/issues/2384

doc/source/release.rst

@@ -15,14 +15,14 @@ API changes
 
 - Functions taking an ``inplace`` option return the calling object as before. A
   deprecation message has been added
-- Groupby aggregations Max/Min no longer exclude non-numeric data (GH2700_)
+- Groupby aggregations Max/Min no longer exclude non-numeric data (:issue:`2700`)
 - Resampling an empty DataFrame now returns an empty DataFrame instead of
-  raising an exception (GH2640_)
+  raising an exception (:issue:`2640`)
 - The file reader will now raise an exception when NA values are found in an
   explicitly specified integer column instead of converting the column to float
-  (GH2631_)
+  (:issue:`2631`)
 - DatetimeIndex.unique now returns a DatetimeIndex with the same name and
-- timezone instead of an array (GH2563_)
+- timezone instead of an array (:issue:`2563`)
 
 New features
 ~~~~~~~~~~~~
@@ -164,76 +164,49 @@ combined result, by using ``where`` on a selector table.
 - ``Select`` now supports passing ``start`` and ``stop`` to provide selection
   space limiting in selection.
 
-- Greatly improved ISO8601 (e.g., yyyy-mm-dd) date parsing for file parsers (GH2698_)
+- Greatly improved ISO8601 (e.g., yyyy-mm-dd) date parsing for file parsers (:issue:`2698`)
 - Allow ``DataFrame.merge`` to handle combinatorial sizes too large for 64-bit
-  integer (GH2690_)
-- Series now has unary negation (-series) and inversion (~series) operators (GH2686_)
-- DataFrame.plot now includes a ``logx`` parameter to change the x-axis to log scale (GH2327_)
-- Series arithmetic operators can now handle constant and ndarray input (GH2574_)
-- ExcelFile now takes a ``kind`` argument to specify the file type (GH2613_)
-- A faster implementation for Series.str methods (GH2602_)
+  integer (:issue:`2690`)
+- Series now has unary negation (-series) and inversion (~series) operators (:issue:`2686`)
+- DataFrame.plot now includes a ``logx`` parameter to change the x-axis to log scale (:issue:`2327`)
+- Series arithmetic operators can now handle constant and ndarray input (:issue:`2574`)
+- ExcelFile now takes a ``kind`` argument to specify the file type (:issue:`2613`)
+- A faster implementation for Series.str methods (:issue:`2602`)
 
 **Bug Fixes**
 
 - ``HDFStore`` tables can now store ``float32`` types correctly (cannot be
   mixed with ``float64`` however)
-- Fixed Google Analytics prefix when specifying request segment (GH2713_).
+- Fixed Google Analytics prefix when specifying request segment (:issue:`2713`).
 - Function to reset Google Analytics token store so users can recover from
-  improperly setup client secrets (GH2687_).
-- Fixed groupby bug resulting in segfault when passing in MultiIndex (GH2706_)
+  improperly setup client secrets (:issue:`2687`).
+- Fixed groupby bug resulting in segfault when passing in MultiIndex (:issue:`2706`)
 - Fixed bug where passing a Series with datetime64 values into `to_datetime`
-  results in bogus output values (GH2699_)
+  results in bogus output values (:issue:`2699`)
 - Fixed bug in ``pattern in HDFStore`` expressions when pattern is not a valid
-  regex (GH2694_)
-- Fixed performance issues while aggregating boolean data (GH2692_)
+  regex (:issue:`2694`)
+- Fixed performance issues while aggregating boolean data (:issue:`2692`)
 - When given a boolean mask key and a Series of new values, Series __setitem__
-  will now align the incoming values with the original Series (GH2686_)
+  will now align the incoming values with the original Series (:issue:`2686`)
 - Fixed MemoryError caused by performing counting sort on sorting MultiIndex
-  levels with a very large number of combinatorial values (GH2684_)
+  levels with a very large number of combinatorial values (:issue:`2684`)
 - Fixed bug that causes plotting to fail when the index is a DatetimeIndex with
-  a fixed-offset timezone (GH2683_)
+  a fixed-offset timezone (:issue:`2683`)
 - Corrected businessday subtraction logic when the offset is more than 5 bdays
-  and the starting date is on a weekend (GH2680_)
+  and the starting date is on a weekend (:issue:`2680`)
 - Fixed C file parser behavior when the file has more columns than data
-  (GH2668_)
+  (:issue:`2668`)
 - Fixed file reader bug that misaligned columns with data in the presence of an
   implicit column and a specified `usecols` value
 - DataFrames with numerical or datetime indices are now sorted prior to
-  plotting (GH2609_)
+  plotting (:issue:`2609`)
 - Fixed DataFrame.from_records error when passed columns, index, but empty
-  records (GH2633_)
-- Several bug fixed for Series operations when dtype is datetime64 (GH2689_,
-  GH2629_, GH2626_)
+  records (:issue:`2633`)
+- Several bug fixed for Series operations when dtype is datetime64 (:issue:`2689`,
+  :issue:`2629`, :issue:`2626`)
 
 
-See the `full release notes
-<https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
+See the :ref:`full release notes
+<release>` or issue tracker
 on GitHub for a complete list.
 
-.. _GH2706: https://github.com/pydata/pandas/issues/2706
-.. _GH2700: https://github.com/pydata/pandas/issues/2700
-.. _GH2699: https://github.com/pydata/pandas/issues/2699
-.. _GH2698: https://github.com/pydata/pandas/issues/2698
-.. _GH2694: https://github.com/pydata/pandas/issues/2694
-.. _GH2692: https://github.com/pydata/pandas/issues/2692
-.. _GH2690: https://github.com/pydata/pandas/issues/2690
-.. _GH2713: https://github.com/pydata/pandas/issues/2713
-.. _GH2689: https://github.com/pydata/pandas/issues/2689
-.. _GH2686: https://github.com/pydata/pandas/issues/2686
-.. _GH2684: https://github.com/pydata/pandas/issues/2684
-.. _GH2683: https://github.com/pydata/pandas/issues/2683
-.. _GH2680: https://github.com/pydata/pandas/issues/2680
-.. _GH2668: https://github.com/pydata/pandas/issues/2668
-.. _GH2640: https://github.com/pydata/pandas/issues/2640
-.. _GH2609: https://github.com/pydata/pandas/issues/2609
-.. _GH2327: https://github.com/pydata/pandas/issues/2327
-.. _GH2574: https://github.com/pydata/pandas/issues/2574
-.. _GH2609: https://github.com/pydata/pandas/issues/2609
-.. _GH2631: https://github.com/pydata/pandas/issues/2631
-.. _GH2633: https://github.com/pydata/pandas/issues/2633
-.. _GH2629: https://github.com/pydata/pandas/issues/2629
-.. _GH2626: https://github.com/pydata/pandas/issues/2626
-.. _GH2613: https://github.com/pydata/pandas/issues/2613
-.. _GH2602: https://github.com/pydata/pandas/issues/2602
-.. _GH2687: https://github.com/pydata/pandas/issues/2687
-.. _GH2563: https://github.com/pydata/pandas/issues/2563

doc/source/v0.10.0.txt

@@ -129,7 +129,7 @@ Dtype Gotchas
 
 Starting in 0.11.0, construction of DataFrame/Series will use default dtypes of ``int64`` and ``float64``,
 *regardless of platform*. This is not an apparent change from earlier versions of pandas. If you specify
-dtypes, they *WILL* be respected, however (GH2837_)
+dtypes, they *WILL* be respected, however (:issue:`2837`)
 
 The following will all result in ``int64`` dtypes
 
@@ -176,7 +176,7 @@ Datetimes Conversion
 Datetime64[ns] columns in a DataFrame (or a Series) allow the use of ``np.nan`` to indicate a nan value,
 in addition to the traditional ``NaT``, or not-a-time. This allows convenient nan setting in a generic way.
 Furthermore ``datetime64[ns]`` columns are created by default, when passed datetimelike objects (*this change was introduced in 0.10.1*)
-(GH2809_, GH2810_)
+(:issue:`2809`, :issue:`2810`)
 
 .. ipython:: python
 
@@ -210,7 +210,7 @@ API changes
 ~~~~~~~~~~~
 
   - Added to_series() method to indicies, to facilitate the creation of indexers
-    (GH3275_)
+    (:issue:`3275`)
 
   - ``HDFStore``
 
@@ -221,7 +221,7 @@ API changes
 Enhancements
 ~~~~~~~~~~~~
 
-  - Improved performance of df.to_csv() by up to 10x in some cases. (GH3059_)
+  - Improved performance of df.to_csv() by up to 10x in some cases. (:issue:`3059`)
 
   - Numexpr is now a :ref:`Recommended Dependencies <install.recommended_dependencies>`, to accelerate certain
     types of numerical and boolean operations
@@ -248,11 +248,11 @@ Enhancements
     - provide dotted attribute access to ``get`` from stores, e.g. ``store.df == store['df']``
 
     - new keywords ``iterator=boolean``, and ``chunksize=number_in_a_chunk`` are
-      provided to support iteration on ``select`` and ``select_as_multiple`` (GH3076_)
+      provided to support iteration on ``select`` and ``select_as_multiple`` (:issue:`3076`)
 
-  - You can now select timestamps from an *unordered* timeseries similarly to an *ordered* timeseries (GH2437_)
+  - You can now select timestamps from an *unordered* timeseries similarly to an *ordered* timeseries (:issue:`2437`)
 
-  - You can now select with a string from a DataFrame with a datelike index, in a similar way to a Series (GH3070_)
+  - You can now select with a string from a DataFrame with a datelike index, in a similar way to a Series (:issue:`3070`)
 
     .. ipython:: python
 
@@ -291,59 +291,36 @@ Enhancements
       ``above_below``. This allows the user to specify if they would like to
       only return forward looking data for options near the current stock
       price. This just obtains the data from Options.get_near_stock_price
-      instead of Options.get_xxx_data() (GH2758_).
+      instead of Options.get_xxx_data() (:issue:`2758`).
 
   - Cursor coordinate information is now displayed in time-series plots.
 
   - added option `display.max_seq_items` to control the number of
-    elements printed per sequence pprinting it.  (GH2979_)
+    elements printed per sequence pprinting it.  (:issue:`2979`)
 
   - added option `display.chop_threshold` to control display of small numerical
-    values. (GH2739_)
+    values. (:issue:`2739`)
 
   - added option `display.max_info_rows` to prevent verbose_info from being
-    calculated for frames above 1M rows (configurable). (GH2807_, GH2918_)
+    calculated for frames above 1M rows (configurable). (:issue:`2807`, :issue:`2918`)
 
   - value_counts() now accepts a "normalize" argument, for normalized
-    histograms. (GH2710_).
+    histograms. (:issue:`2710`).
 
   - DataFrame.from_records now accepts not only dicts but any instance of
     the collections.Mapping ABC.
 
   - added option `display.mpl_style` providing a sleeker visual style
-    for plots. Based on https://gist.github.com/huyng/816622 (GH3075_).
+    for plots. Based on https://gist.github.com/huyng/816622 (:issue:`3075`).
 
   - Treat boolean values as integers (values 1 and 0) for numeric
-    operations. (GH2641_)
+    operations. (:issue:`2641`)
 
   - to_html() now accepts an optional "escape" argument to control reserved
     HTML character escaping (enabled by default) and escapes ``&``, in addition
-    to ``<`` and ``>``.  (GH2919_)
+    to ``<`` and ``>``.  (:issue:`2919`)
 
-See the `full release notes
-<https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
+See the :ref:`full release notes
+<release>` or issue tracker
 on GitHub for a complete list.
 
-.. _GH2437: https://github.com/pydata/pandas/issues/2437
-.. _GH2809: https://github.com/pydata/pandas/issues/2809
-.. _GH2810: https://github.com/pydata/pandas/issues/2810
-.. _GH2837: https://github.com/pydata/pandas/issues/2837
-.. _GH2898: https://github.com/pydata/pandas/issues/2898
-.. _GH3035: https://github.com/pydata/pandas/issues/3035
-.. _GH2978: https://github.com/pydata/pandas/issues/2978
-.. _GH2877: https://github.com/pydata/pandas/issues/2877
-.. _GH2739: https://github.com/pydata/pandas/issues/2739
-.. _GH2710: https://github.com/pydata/pandas/issues/2710
-.. _GH2806: https://github.com/pydata/pandas/issues/2806
-.. _GH2807: https://github.com/pydata/pandas/issues/2807
-.. _GH2918: https://github.com/pydata/pandas/issues/2918
-.. _GH2758: https://github.com/pydata/pandas/issues/2758
-.. _GH3275: https://github.com/pydata/pandas/issues/3275
-.. _GH2979: https://github.com/pydata/pandas/issues/2979
-.. _GH3011: https://github.com/pydata/pandas/issues/3011
-.. _GH3076: https://github.com/pydata/pandas/issues/3076
-.. _GH3059: https://github.com/pydata/pandas/issues/3059
-.. _GH3070: https://github.com/pydata/pandas/issues/3070
-.. _GH3075: https://github.com/pydata/pandas/issues/3075
-.. _GH2641: https://github.com/pydata/pandas/issues/2641
-.. _GH2919: https://github.com/pydata/pandas/issues/2919