sphinxext-ip/README.rst
Jan Dittberner 01c31e9263 Implement proper clear_doc method for IPDomain
This commit replaces the dummy clear_doc method in
jandd.sphinxext.ip.IPDomain with a proper implementation that clears
document related items from the domain data dictionary.
2016-05-05 11:34:27 +02:00

41 lines
960 B
ReStructuredText

==================
jandd.sphinxext.ip
==================
This is an IP address extension for `Sphinx`_. The extension provides a domain
*ip* that allows marking IPv4 and IPv6 addresses in documentation and contains
directives to collect information regarding IP addresses in IP ranges.
.. _Sphinx: http://www.sphinx-doc.org/
Development
===========
The extension is developed in a git repository that can be cloned by running::
git clone https://git.dittberner.info/sphinxext-ip.git
A repository browser is available at
https://git.dittberner.info/?p=sphinxext-ip.git.
Contributors
============
* `Jan Dittberner`_
.. _Jan Dittberner: https://jan.dittberner.info/
Changes
=======
0.2.1 - to be released
----------------------
* fix handling of invalid IP address/range values
* implement a proper clear_doc method for the ip domain
0.2.0 - 2016-05-04
------------------
* display IP address lists as tables
* sort IP address lists numericaly