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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
|
#!/usr/bin/env python
import sys
import unittest
from mkdocs.structure.files import File, Files, set_exclusions
from mkdocs.structure.nav import Section, _get_by_type, get_navigation
from mkdocs.structure.pages import Page
from mkdocs.tests.base import dedent, load_config
class SiteNavigationTests(unittest.TestCase):
maxDiff = None
def test_simple_nav(self):
nav_cfg = [
{'Home': 'index.md'},
{'About': 'about.md'},
]
expected = dedent(
"""
Page(title='Home', url='/')
Page(title='About', url='/about/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [
File(list(item.values())[0], cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)
for item in nav_cfg
]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 2)
self.assertEqual(len(site_navigation.pages), 2)
self.assertEqual(repr(site_navigation.homepage), "Page(title='Home', url='/')")
def test_nav_no_directory_urls(self):
nav_cfg = [
{'Home': 'index.md'},
{'About': 'about.md'},
]
expected = dedent(
"""
Page(title='Home', url='/index.html')
Page(title='About', url='/about.html')
"""
)
cfg = load_config(nav=nav_cfg, use_directory_urls=False, site_url='http://example.com/')
fs = [
File(list(item.values())[0], cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)
for item in nav_cfg
]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 2)
self.assertEqual(len(site_navigation.pages), 2)
self.assertEqual(repr(site_navigation.homepage), "Page(title='Home', url='/index.html')")
def test_nav_missing_page(self):
nav_cfg = [
{'Home': 'index.md'},
]
expected = dedent(
"""
Page(title='Home', url='/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [
File('index.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
File('page_not_in_nav.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 1)
self.assertEqual(len(site_navigation.pages), 1)
for file in files:
self.assertIsInstance(file.page, Page)
def test_nav_no_title(self):
nav_cfg = [
'index.md',
{'About': 'about.md'},
]
expected = dedent(
"""
Page(title=[blank], url='/')
Page(title='About', url='/about/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [
File(nav_cfg[0], cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
File(nav_cfg[1]['About'], cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 2)
self.assertEqual(len(site_navigation.pages), 2)
def test_nav_external_links(self):
nav_cfg = [
{'Home': 'index.md'},
{'Local': '/local.html'},
{'External': 'http://example.com/external.html'},
]
expected = dedent(
"""
Page(title='Home', url='/')
Link(title='Local', url='/local.html')
Link(title='External', url='http://example.com/external.html')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [File('index.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)]
files = Files(fs)
with self.assertLogs('mkdocs', level='DEBUG') as cm:
site_navigation = get_navigation(files, cfg)
self.assertEqual(
cm.output,
[
"INFO:mkdocs.structure.nav:An absolute path to '/local.html' is included in the 'nav' configuration, which presumably points to an external resource.",
"DEBUG:mkdocs.structure.nav:An external link to 'http://example.com/external.html' is included in the 'nav' configuration.",
],
)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 3)
self.assertEqual(len(site_navigation.pages), 1)
def test_nav_absolute_links_with_validation(self):
nav_cfg = [
{'Home': 'index.md'},
{'Local page': '/foo/bar.md'},
{'Local link': '/local.md'},
{'External': 'http://example.com/external.html'},
]
expected = dedent(
"""
Page(title='Home', url='/')
Page(title='Local page', url='/foo/bar/')
Link(title='Local link', url='/local.md')
Link(title='External', url='http://example.com/external.html')
"""
)
cfg = load_config(
nav=nav_cfg,
site_url='http://example.com/',
validation=dict(nav=dict(absolute_links='relative_to_docs')),
)
fs = [
File('index.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
File('foo/bar.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
]
files = Files(fs)
with self.assertLogs('mkdocs', level='DEBUG') as cm:
site_navigation = get_navigation(files, cfg)
self.assertEqual(
cm.output,
[
"WARNING:mkdocs.structure.nav:A reference to '/local.md' is included in the 'nav' configuration, which is not found in the documentation files.",
"DEBUG:mkdocs.structure.nav:An external link to 'http://example.com/external.html' is included in the 'nav' configuration.",
],
)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 4)
self.assertEqual(len(site_navigation.pages), 2)
def test_nav_bad_links(self):
nav_cfg = [
{'Home': 'index.md'},
{'Missing': 'missing.html'},
{'Bad External': 'example.com'},
]
expected = dedent(
"""
Page(title='Home', url='/')
Link(title='Missing', url='missing.html')
Link(title='Bad External', url='example.com')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [File('index.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)]
files = Files(fs)
with self.assertLogs('mkdocs') as cm:
site_navigation = get_navigation(files, cfg)
self.assertEqual(
cm.output,
[
"WARNING:mkdocs.structure.nav:A reference to 'missing.html' is included in the 'nav' configuration, which is not found in the documentation files.",
"WARNING:mkdocs.structure.nav:A reference to 'example.com' is included in the 'nav' configuration, which is not found in the documentation files.",
],
)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 3)
self.assertEqual(len(site_navigation.pages), 1)
def test_indented_nav(self):
nav_cfg = [
{'Home': 'index.md'},
{
'API Guide': [
{'Running': 'api-guide/running.md'},
{'Testing': 'api-guide/testing.md'},
{'Debugging': 'api-guide/debugging.md'},
{
'Advanced': [
{'Part 1': 'api-guide/advanced/part-1.md'},
]
},
]
},
{
'About': [
{'Release notes': 'about/release-notes.md'},
{'License': '/license.html'},
]
},
{'External': 'https://example.com/'},
]
expected = dedent(
"""
Page(title='Home', url='/')
Section(title='API Guide')
Page(title='Running', url='/api-guide/running/')
Page(title='Testing', url='/api-guide/testing/')
Page(title='Debugging', url='/api-guide/debugging/')
Section(title='Advanced')
Page(title='Part 1', url='/api-guide/advanced/part-1/')
Section(title='About')
Page(title='Release notes', url='/about/release-notes/')
Link(title='License', url='/license.html')
Link(title='External', url='https://example.com/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [
'index.md',
'api-guide/running.md',
'api-guide/testing.md',
'api-guide/debugging.md',
'api-guide/advanced/part-1.md',
'about/release-notes.md',
]
files = Files([File(s, cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls) for s in fs])
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 4)
self.assertEqual(len(site_navigation.pages), 6)
self.assertEqual(repr(site_navigation.homepage), "Page(title='Home', url='/')")
self.assertIsNone(site_navigation.items[0].parent)
self.assertEqual(site_navigation.items[0].ancestors, [])
self.assertIsNone(site_navigation.items[1].parent)
self.assertEqual(site_navigation.items[1].ancestors, [])
self.assertEqual(len(site_navigation.items[1].children), 4)
self.assertEqual(
repr(site_navigation.items[1].children[0].parent), "Section(title='API Guide')"
)
self.assertEqual(site_navigation.items[1].children[0].ancestors, [site_navigation.items[1]])
self.assertEqual(
repr(site_navigation.items[1].children[1].parent), "Section(title='API Guide')"
)
self.assertEqual(site_navigation.items[1].children[1].ancestors, [site_navigation.items[1]])
self.assertEqual(
repr(site_navigation.items[1].children[2].parent), "Section(title='API Guide')"
)
self.assertEqual(site_navigation.items[1].children[2].ancestors, [site_navigation.items[1]])
self.assertEqual(
repr(site_navigation.items[1].children[3].parent), "Section(title='API Guide')"
)
self.assertEqual(site_navigation.items[1].children[3].ancestors, [site_navigation.items[1]])
self.assertEqual(len(site_navigation.items[1].children[3].children), 1)
self.assertEqual(
repr(site_navigation.items[1].children[3].children[0].parent),
"Section(title='Advanced')",
)
self.assertEqual(
site_navigation.items[1].children[3].children[0].ancestors,
[site_navigation.items[1].children[3], site_navigation.items[1]],
)
self.assertIsNone(site_navigation.items[2].parent)
self.assertEqual(len(site_navigation.items[2].children), 2)
self.assertEqual(
repr(site_navigation.items[2].children[0].parent), "Section(title='About')"
)
self.assertEqual(site_navigation.items[2].children[0].ancestors, [site_navigation.items[2]])
self.assertEqual(
repr(site_navigation.items[2].children[1].parent), "Section(title='About')"
)
self.assertEqual(site_navigation.items[2].children[1].ancestors, [site_navigation.items[2]])
self.assertIsNone(site_navigation.items[3].parent)
self.assertEqual(site_navigation.items[3].ancestors, [])
self.assertIsNone(site_navigation.items[3].children)
def test_nested_ungrouped_nav(self):
nav_cfg = [
{'Home': 'index.md'},
{'Contact': 'about/contact.md'},
{'License Title': 'about/sub/license.md'},
]
expected = dedent(
"""
Page(title='Home', url='/')
Page(title='Contact', url='/about/contact/')
Page(title='License Title', url='/about/sub/license/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [
File(list(item.values())[0], cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)
for item in nav_cfg
]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 3)
self.assertEqual(len(site_navigation.pages), 3)
def test_nested_ungrouped_nav_no_titles(self):
nav_cfg = [
'index.md',
'about/contact.md',
'about/sub/license.md',
]
expected = dedent(
"""
Page(title=[blank], url='/')
Page(title=[blank], url='/about/contact/')
Page(title=[blank], url='/about/sub/license/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [File(item, cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls) for item in nav_cfg]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 3)
self.assertEqual(len(site_navigation.pages), 3)
self.assertEqual(repr(site_navigation.homepage), "Page(title=[blank], url='/')")
@unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
def test_nested_ungrouped_no_titles_windows(self):
nav_cfg = [
'index.md',
'about\\contact.md',
'about\\sub\\license.md',
]
expected = dedent(
"""
Page(title=[blank], url='/')
Page(title=[blank], url='/about/contact/')
Page(title=[blank], url='/about/sub/license/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [File(item, cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls) for item in nav_cfg]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 3)
self.assertEqual(len(site_navigation.pages), 3)
def test_nav_from_files(self):
expected = dedent(
"""
Page(title=[blank], url='/')
Page(title=[blank], url='/about/')
"""
)
cfg = load_config(site_url='http://example.com/')
fs = [
File('index.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
File('about.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls),
]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 2)
self.assertEqual(len(site_navigation.pages), 2)
self.assertEqual(repr(site_navigation.homepage), "Page(title=[blank], url='/')")
def test_nav_from_nested_files(self):
expected = dedent(
"""
Page(title=[blank], url='/')
Section(title='About')
Page(title=[blank], url='/about/license/')
Page(title=[blank], url='/about/release-notes/')
Section(title='Api guide')
Page(title=[blank], url='/api-guide/debugging/')
Page(title=[blank], url='/api-guide/running/')
Page(title=[blank], url='/api-guide/testing/')
Section(title='Advanced')
Page(title=[blank], url='/api-guide/advanced/part-1/')
"""
)
cfg = load_config(site_url='http://example.com/')
fs = [
'index.md',
'about/license.md',
'about/release-notes.md',
'api-guide/debugging.md',
'api-guide/running.md',
'api-guide/testing.md',
'api-guide/advanced/part-1.md',
]
files = Files([File(s, cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls) for s in fs])
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 3)
self.assertEqual(len(site_navigation.pages), 7)
self.assertEqual(repr(site_navigation.homepage), "Page(title=[blank], url='/')")
def test_nav_with_exclusion(self):
expected = dedent(
"""
Page(title=[blank], url='index.html')
Section(title='About')
Page(title=[blank], url='about/license.html')
Page(title=[blank], url='about/release-notes.html')
Section(title='Api guide')
Page(title=[blank], url='api-guide/running.html')
Page(title=[blank], url='api-guide/testing.html')
"""
)
cfg = load_config(use_directory_urls=False, not_in_nav='*ging.md\n/foo.md\n')
fs = [
'index.md',
'foo.md',
'about/license.md',
'about/release-notes.md',
'api-guide/debugging.md',
'api-guide/running.md',
'api-guide/testing.md',
]
files = Files([File(s, cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls) for s in fs])
set_exclusions(files, cfg)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 3)
self.assertEqual(len(site_navigation.pages), 5)
def test_nav_page_subclass(self):
class PageSubclass(Page):
pass
nav_cfg = [
{'Home': 'index.md'},
{'About': 'about.md'},
]
expected = dedent(
"""
PageSubclass(title=[blank], url='/')
PageSubclass(title=[blank], url='/about/')
"""
)
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [
File(list(item.values())[0], cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)
for item in nav_cfg
]
files = Files(fs)
for file in files:
PageSubclass(None, file, cfg)
site_navigation = get_navigation(files, cfg)
self.assertEqual(str(site_navigation).strip(), expected)
self.assertEqual(len(site_navigation.items), 2)
self.assertEqual(len(site_navigation.pages), 2)
self.assertEqual(repr(site_navigation.homepage), "PageSubclass(title=[blank], url='/')")
def test_active(self):
nav_cfg = [
{'Home': 'index.md'},
{
'API Guide': [
{'Running': 'api-guide/running.md'},
{'Testing': 'api-guide/testing.md'},
{'Debugging': 'api-guide/debugging.md'},
{
'Advanced': [
{'Part 1': 'api-guide/advanced/part-1.md'},
]
},
]
},
{
'About': [
{'Release notes': 'about/release-notes.md'},
{'License': 'about/license.md'},
]
},
]
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [
'index.md',
'api-guide/running.md',
'api-guide/testing.md',
'api-guide/debugging.md',
'api-guide/advanced/part-1.md',
'about/release-notes.md',
'about/license.md',
]
files = Files([File(s, cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls) for s in fs])
site_navigation = get_navigation(files, cfg)
# Confirm nothing is active
self.assertTrue(all(page.active is False for page in site_navigation.pages))
self.assertTrue(all(item.active is False for item in site_navigation.items))
# Activate
site_navigation.items[1].children[3].children[0].active = True
# Confirm ancestors are activated
self.assertTrue(site_navigation.items[1].children[3].children[0].active)
self.assertTrue(site_navigation.items[1].children[3].active)
self.assertTrue(site_navigation.items[1].active)
# Confirm non-ancestors are not activated
self.assertFalse(site_navigation.items[0].active)
self.assertFalse(site_navigation.items[1].children[0].active)
self.assertFalse(site_navigation.items[1].children[1].active)
self.assertFalse(site_navigation.items[1].children[2].active)
self.assertFalse(site_navigation.items[2].active)
self.assertFalse(site_navigation.items[2].children[0].active)
self.assertFalse(site_navigation.items[2].children[1].active)
# Deactivate
site_navigation.items[1].children[3].children[0].active = False
# Confirm ancestors are deactivated
self.assertFalse(site_navigation.items[1].children[3].children[0].active)
self.assertFalse(site_navigation.items[1].children[3].active)
self.assertFalse(site_navigation.items[1].active)
def test_get_by_type_nested_sections(self):
nav_cfg = [
{
'Section 1': [
{
'Section 2': [
{'Page': 'page.md'},
]
},
]
},
]
cfg = load_config(nav=nav_cfg, site_url='http://example.com/')
fs = [File('page.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)]
files = Files(fs)
site_navigation = get_navigation(files, cfg)
self.assertEqual(len(_get_by_type(site_navigation, Section)), 2)
|