Doc update (#31)

TomAugspurger · web-flow · commit dc755bd41169 · 2018-05-19T06:22:43.000-05:00
* DOC: Added whatsnew

* DOC: updates

* DOC: updates
diff --git a/docs/source/_static/.gitignore b/docs/source/_static/.gitignore
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -19,6 +19,10 @@ Dedicated alternate constructors are also available.
 .. automethod:: IPArray.from_pyints
 .. automethod:: IPArray.from_bytes
 
+Finally, the top-level ``ip_range`` method can be used.
+
+.. autofunction:: ip_range
+
 Serialization
 """""""""""""
 
@@ -63,5 +67,5 @@ IP addresss-specific attributes.
 
 :class:`MACArray`
 -----------------
-
+utofun
 .. autoclass:: MACArray
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1,11 @@
+#########
+Changelog
+#########
+
+*************
+Version 1.1.0
+*************
+
+- Added :func:`ip_range` for generating an array of regularly-spaced IP addresses (:issue:`27`).
+- Added :meth:`IPArray.netmask` and :meth:`IPArray.hostmask` (:issue:`30`).
+- Fixed Python 2 dependencies so that the `ipaddress` backport is installed automatically when install cyberpandas from PyPI (:issue:`29`).
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,6 +36,7 @@
     'sphinx.ext.autosummary',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks',
     'numpydoc',
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive',
@@ -169,6 +170,9 @@
     'pandas': ('http://pandas-docs.github.io/pandas-docs-travis/', None),
 }
 
+extlinks = {
+    'issue': ('https://github.com/dask/dask-ml/issues/%s', 'GH#'),
+}
 
 ipython_execlines = [
     "import ipaddress",
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -60,6 +60,7 @@ API
    install.rst
    usage.rst
    api.rst
+   changelog.rst
 
 
 
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -8,6 +8,6 @@ Once pandas is installed, cyberpandas can be installed from conda-forge::
 
     conda install -c conda-forge cyberpandas
 
-Or PyPI:
+Or PyPI::
 
     pip install cyberpandas
