jan/sphinxext-ip
1
0
Fork 0
Code Issues Pull requests Releases 2 Wiki Activity
Sphinx IP address extension
61 commits 1 branch 12 tags 327 KiB
Python 80.1%
Makefile 19.9%
Find a file
Jan Dittberner 49a3d89488 Reimplement using Sphinx 4 APIs 
- use ObjectDescription for IPRange
- reimplement data handling in IPDomain
- store target docname and anchors in data to avoid later lookups
- remove broken entries from index
- adapt tests
2021-09-04 17:15:27 +02:00
jandd Reimplement using Sphinx 4 APIs 2021-09-04 17:15:27 +02:00
tests Reimplement using Sphinx 4 APIs 2021-09-04 17:15:27 +02:00
.gitignore Fix deprecations and modernize testing 2021-01-02 07:24:22 +01:00
CHANGES.rst Switch to PEP 517 build, drop tox 2021-01-02 07:24:22 +01:00
COPYING Initial version of the IP Sphinx extension 2016-04-16 23:43:22 +02:00
MANIFEST.in Fix deprecations and modernize testing 2021-01-02 07:24:22 +01:00
Pipfile Update to Sphinx 4 2021-09-04 17:14:18 +02:00
Pipfile.lock Update to Sphinx 4 2021-09-04 17:14:18 +02:00
pyproject.toml Switch to PEP 517 build, drop tox 2021-01-02 07:24:22 +01:00
README.rst Switch to PEP 517 build, drop tox 2021-01-02 07:24:22 +01:00
setup.cfg Update to Sphinx 4 2021-09-04 17:14:18 +02:00
setup.py Update to Sphinx 4 2021-09-04 17:14:18 +02:00

README.rst

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.

Development

The extension is developed in a git repository that can be cloned by running:

git clone https://git.dittberner.info/jan/sphinxext-ip.git

Running test

To install all dependencies and run the tests use:

pipenv install --dev
pipenv run pytest

Contributors