sphinxext-ip/README.rst

32 lines
722 B
ReStructuredText
Raw Normal View History

==================
jandd.sphinxext.ip
==================
2016-05-01 18:12:02 +02:00
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::
2019-07-13 21:52:26 +02:00
git clone https://git.dittberner.info/jan/sphinxext-ip.git
2021-01-02 07:22:11 +01:00
Running test
------------
To install all dependencies and run the tests use::
pipenv install --dev
pipenv run pytest
2016-05-01 18:12:02 +02:00
Contributors
============
2016-05-01 18:12:02 +02:00
* `Jan Dittberner`_
.. _Jan Dittberner: https://jan.dittberner.info/