From b5a50256b60ecb6e0a3477158f503ec030f3eb9b Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Thu, 5 May 2016 11:55:57 +0200 Subject: [PATCH 1/3] Fix index entries that broke the latex builder This commit fixes the element count of index entries so that the latex builder is not broken anymore. The version number is bumped to 0.2.2. --- README.rst | 5 +++++ jandd/sphinxext/ip.py | 6 +++--- setup.py | 2 +- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index d2f696b..7591baf 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,11 @@ Contributors Changes ======= +0.2.2 - to be released +---------------------- + +* fix index entries that broke the latex builder + 0.2.1 - 2016-05-05 ------------------ diff --git a/jandd/sphinxext/ip.py b/jandd/sphinxext/ip.py index fe25208..95cde86 100644 --- a/jandd/sphinxext/ip.py +++ b/jandd/sphinxext/ip.py @@ -23,7 +23,7 @@ from sphinx.locale import l_ from sphinx.roles import XRefRole from sphinx.util.nodes import make_refnode -__version__ = '0.2.1' +__version__ = '0.2.2' def ip_object_anchor(typ, path): @@ -120,8 +120,8 @@ class IPRange(Directive): doctitle = self.state.document.traverse(nodes.title)[0].astext() idx_text = "%s; %s" % (self.rangespec, doctitle) self.indexnode = addnodes.index(entries=[ - ('single', idx_text, name, ''), - ('single', self.get_index_text(), name, '') + ('single', idx_text, name, False, ''), + ('single', self.get_index_text(), name, False, '') ]) if self.content: diff --git a/setup.py b/setup.py index 4a22ff9..350756f 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup, find_packages -version = '0.2.1' +version = '0.2.2' with open('README.rst') as readme: description = readme.read() + "\n\n" From 020ac6d0bb95b4460621753f420a7aa25af489ae Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Thu, 5 May 2016 11:59:23 +0200 Subject: [PATCH 2/3] Move change log to a separate file --- CHANGES.rst | 19 +++++++++++++++++++ README.rst | 20 -------------------- setup.py | 3 +++ 3 files changed, 22 insertions(+), 20 deletions(-) create mode 100644 CHANGES.rst diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..75d7a0e --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,19 @@ +Changes +======= + +0.2.2 - to be released +---------------------- + +* 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 diff --git a/README.rst b/README.rst index 7591baf..522567b 100644 --- a/README.rst +++ b/README.rst @@ -24,23 +24,3 @@ Contributors * `Jan Dittberner`_ .. _Jan Dittberner: https://jan.dittberner.info/ - -Changes -======= - -0.2.2 - to be released ----------------------- - -* 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 diff --git a/setup.py b/setup.py index 350756f..827a99d 100644 --- a/setup.py +++ b/setup.py @@ -7,6 +7,9 @@ version = '0.2.2' with open('README.rst') as readme: description = readme.read() + "\n\n" +with open('CHANGES.rst') as changes: + description += changes.read() + requires = ['Sphinx>=1.4', 'ipcalc>=1.99'] tests_requires = ['path.py>=8.2.1'] From e95f37950bbfec07816e7d45855040b2a88ca63f Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Thu, 5 May 2016 12:00:08 +0200 Subject: [PATCH 3/3] Finalize change log for 0.2.2 --- CHANGES.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 75d7a0e..3f2d891 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,8 +1,8 @@ Changes ======= -0.2.2 - to be released ----------------------- +0.2.2 - 2016-05-05 +------------------ * fix index entries that broke the latex builder