Skip to content

Doc update #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added docs/source/_static/.gitignore
Empty file.
6 changes: 5 additions & 1 deletion docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""""""""""""

Expand Down Expand Up @@ -63,5 +67,5 @@ IP addresss-specific attributes.

:class:`MACArray`
-----------------

utofun
.. autoclass:: MACArray
11 changes: 11 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -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`).
4 changes: 4 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ API
install.rst
usage.rst
api.rst
changelog.rst



Expand Down
2 changes: 1 addition & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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