Skip to content

Commit

Permalink
remove markup for terms, list items, remove toc items entirely #5
Browse files Browse the repository at this point in the history
  • Loading branch information
TimKam committed Sep 13, 2016
1 parent b90f1a1 commit 68c843e
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 8 deletions.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
setuptools.setup(
name='sphinxprettysearchresults',
packages=['sphinxprettysearchresults'],
version='0.1.5',
version='0.1.6',
description='Decently styled search results for sphinx-doc projects',
author='Timotheus Kampik',
author_email='[email protected]',
Expand Down
19 changes: 13 additions & 6 deletions sphinxprettysearchresults/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import os, shutil, subprocess
import docutils.nodes
import shutil, subprocess
import docutils

from docutils.nodes import table, header, image, figure, title, emphasis, strong
from docutils import nodes

from docutils.nodes import *


def clean_txts(language, srcdir, outdir):
Expand Down Expand Up @@ -41,13 +43,18 @@ def remove_text_markup(app, doctree, docname):
+ doctree.traverse(header)\
+ doctree.traverse(title)\
+ doctree.traverse(emphasis)\
+ doctree.traverse(strong)
+ doctree.traverse(strong) \
+ doctree.traverse(list_item) \
+ doctree.traverse(reference)
for node in nodes_to_replace:
newnode = docutils.nodes.line('', node.astext())
newnode = paragraph()
newnode.append(line('', node.astext()))
node.replace_self(newnode)

nodes_to_remove = doctree.traverse(figure)\
+ doctree.traverse(image)
+ doctree.traverse(image)\
+ doctree.traverse(compound)

for node in nodes_to_remove:
node.replace_self(docutils.nodes.line('',''))

Expand Down
19 changes: 19 additions & 0 deletions tests/root/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,22 @@ Lorem ipsum

.. image:: test.png
:alt: image

* list item star

- list item dash

1. list item number

#. list item auto number

.. glossary::

term1
term1 definition

:term:`term1`

.. toctree::

toctree_item
2 changes: 2 additions & 0 deletions tests/root/toctree_item.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
toctree_item
============
17 changes: 16 additions & 1 deletion tests/test_remove_markup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,19 @@ def test_image():

def test_table():
assert lines[12] == ' cell1/1 cell1/2 cell2/1 cell2/2', '%s !=\
" cell1/1 cell1/2 cell2/1 cell2/2"' % (lines[10])
" cell1/1 cell1/2 cell2/1 cell2/2"' % (lines[10])


def test_toc():
assert any('toctree_item' in line for line in lines) == False, '"toctree_item" is in line in lines'


def test_list_item():
assert lines[15] == 'list item star', '%s != "list item star"' % (lines[15])
assert lines[17] == 'list item dash', '%s != "list item dash"' % (lines[17])
assert lines[19] == 'list item number', '%s != "list item number"' % (lines[19])
assert lines[21] == 'list item auto number', '%s != "list item auto number"' % (lines[21])


def test_term():
assert lines[26] == 'term1', '%s != "Level 1 Heading"' % (lines[26])

0 comments on commit 68c843e

Please sign in to comment.