1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
|
#!/usr/bin/env python
import unittest
from mkdocs.structure.toc import get_toc
from mkdocs.tests.base import dedent, get_markdown_toc
class TableOfContentsTests(unittest.TestCase):
def test_indented_toc(self):
md = dedent(
"""
# Heading 1
## Heading 2
### Heading 3
"""
)
expected = dedent(
"""
Heading 1 - #heading-1
Heading 2 - #heading-2
Heading 3 - #heading-3
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 1)
def test_indented_toc_html(self):
md = dedent(
"""
# Heading 1
## <code>Heading</code> 2
## Heading 3
"""
)
expected = dedent(
"""
Heading 1 - #heading-1
Heading 2 - #heading-2
Heading 3 - #heading-3
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 1)
def test_flat_toc(self):
md = dedent(
"""
# Heading 1
# Heading 2
# Heading 3
"""
)
expected = dedent(
"""
Heading 1 - #heading-1
Heading 2 - #heading-2
Heading 3 - #heading-3
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 3)
def test_flat_h2_toc(self):
md = dedent(
"""
## Heading 1
## Heading 2
## Heading 3
"""
)
expected = dedent(
"""
Heading 1 - #heading-1
Heading 2 - #heading-2
Heading 3 - #heading-3
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 3)
def test_mixed_toc(self):
md = dedent(
"""
# Heading 1
## Heading 2
# Heading 3
### Heading 4
### Heading 5
"""
)
expected = dedent(
"""
Heading 1 - #heading-1
Heading 2 - #heading-2
Heading 3 - #heading-3
Heading 4 - #heading-4
Heading 5 - #heading-5
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 2)
def test_mixed_html(self):
md = dedent(
"""
# Heading 1
## Heading 2
# Heading 3
### Heading 4
### <a>Heading 5</a>
"""
)
expected = dedent(
"""
Heading 1 - #heading-1
Heading 2 - #heading-2
Heading 3 - #heading-3
Heading 4 - #heading-4
Heading 5 - #heading-5
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 2)
def test_nested_anchor(self):
md = dedent(
"""
# Heading 1
## Heading 2
# Heading 3
### Heading 4
### <a href="/">Heading 5</a>
"""
)
expected = dedent(
"""
Heading 1 - #heading-1
Heading 2 - #heading-2
Heading 3 - #heading-3
Heading 4 - #heading-4
Heading 5 - #heading-5
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 2)
def test_entityref(self):
md = dedent(
"""
# Heading & 1
## Heading > 2
### Heading < 3
"""
)
expected = dedent(
"""
Heading & 1 - #heading-1
Heading > 2 - #heading-2
Heading < 3 - #heading-3
"""
)
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 1)
def test_charref(self):
md = '# @Header'
expected = '@Header - #header'
toc = get_toc(get_markdown_toc(md))
self.assertEqual(str(toc).strip(), expected)
self.assertEqual(len(toc), 1)
def test_level(self):
md = dedent(
"""
# Heading 1
## Heading 1.1
### Heading 1.1.1
### Heading 1.1.2
## Heading 1.2
"""
)
toc = get_toc(get_markdown_toc(md))
def get_level_sequence(items):
for item in items:
yield item.level
yield from get_level_sequence(item.children)
self.assertEqual(tuple(get_level_sequence(toc)), (1, 2, 3, 3, 2))
|