added podman, json and yaml
This commit is contained in:
77
venv/lib/python3.11/site-packages/mkdocs/structure/toc.py
Normal file
77
venv/lib/python3.11/site-packages/mkdocs/structure/toc.py
Normal file
@ -0,0 +1,77 @@
|
||||
"""
|
||||
Deals with generating the per-page table of contents.
|
||||
|
||||
For the sake of simplicity we use the Python-Markdown `toc` extension to
|
||||
generate a list of dicts for each toc item, and then store it as AnchorLinks to
|
||||
maintain compatibility with older versions of MkDocs.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any, Dict, List
|
||||
|
||||
|
||||
def get_toc(toc_tokens: list) -> TableOfContents:
|
||||
toc = [_parse_toc_token(i) for i in toc_tokens]
|
||||
# For the table of contents, always mark the first element as active
|
||||
if len(toc):
|
||||
toc[0].active = True # type: ignore[attr-defined]
|
||||
return TableOfContents(toc)
|
||||
|
||||
|
||||
class TableOfContents:
|
||||
"""
|
||||
Represents the table of contents for a given page.
|
||||
"""
|
||||
|
||||
def __init__(self, items: list) -> None:
|
||||
self.items = items
|
||||
|
||||
def __iter__(self):
|
||||
return iter(self.items)
|
||||
|
||||
def __len__(self) -> int:
|
||||
return len(self.items)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return ''.join(str(item) for item in self)
|
||||
|
||||
|
||||
class AnchorLink:
|
||||
"""
|
||||
A single entry in the table of contents.
|
||||
"""
|
||||
|
||||
def __init__(self, title: str, id: str, level: int) -> None:
|
||||
self.title, self.id, self.level = title, id, level
|
||||
self.children = []
|
||||
|
||||
title: str
|
||||
"""The text of the item."""
|
||||
|
||||
@property
|
||||
def url(self) -> str:
|
||||
"""The hash fragment of a URL pointing to the item."""
|
||||
return '#' + self.id
|
||||
|
||||
level: int
|
||||
"""The zero-based level of the item."""
|
||||
|
||||
children: List[AnchorLink]
|
||||
"""An iterable of any child items."""
|
||||
|
||||
def __str__(self):
|
||||
return self.indent_print()
|
||||
|
||||
def indent_print(self, depth=0):
|
||||
indent = ' ' * depth
|
||||
ret = f'{indent}{self.title} - {self.url}\n'
|
||||
for item in self.children:
|
||||
ret += item.indent_print(depth + 1)
|
||||
return ret
|
||||
|
||||
|
||||
def _parse_toc_token(token: Dict[str, Any]) -> AnchorLink:
|
||||
anchor = AnchorLink(token['name'], token['id'], token['level'])
|
||||
for i in token['children']:
|
||||
anchor.children.append(_parse_toc_token(i))
|
||||
return anchor
|
||||
Reference in New Issue
Block a user