Skip to main content

IP address extension for Sphinx

Project description

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

Changes

0.5.1 - 2021-09-04

  • fix anchors in links

0.5.0 - 2021-09-04

  • fix Docutils error
  • adapt to Sphinx 4

0.4.0 - 2021-01-02

  • fix Docutils deprecation warning
  • fix test deprecation warning from Sphinx
  • use pytest for testing
  • switch to PEP-517 build API and metadata

0.3.0 - 2019-07-13

  • update to Sphinx 2.1 API

0.2.4 - 2016-05-07

  • fix index generation issue

0.2.3 - 2016-05-05

  • fix regression in HTML builder that has been introduced in 0.2.2

0.2.2 - 2016-05-05

  • fix index entries that broke the latex builder

0.2.1 - 2016-05-05

  • 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jandd.sphinxext.ip, version 0.5.1
Filename, size File type Python version Upload date Hashes
Filename, size jandd.sphinxext.ip-0.5.1-py3-none-any.whl (29.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size jandd.sphinxext.ip-0.5.1.tar.gz (27.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page