mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-17 21:24:28 +00:00
21d8b6288d
* Refactoring in preparation for AMP support * infrastructure for AMP validation * Add Metrika counter on AMP page + adjust layout * more content fixes * improve amp layout * improve navigation * Move converting admonitions to generation time * strict amp test check * Batch AMP validation * Add date published/modified to docs articles and their ld+json meta * few more content fixes * improve ld+json meta * adjust margins * skip published/modified for stable release docs * adapt single page mode * update po * skip published/modified for single page docs * update po * adjust layout * adjust layout
109 lines
4.1 KiB
Python
109 lines
4.1 KiB
Python
import collections
|
|
import logging
|
|
import os
|
|
|
|
import mkdocs.structure.nav
|
|
|
|
import util
|
|
|
|
|
|
def find_first_header(content):
|
|
for line in content.split('\n'):
|
|
if line.startswith('#'):
|
|
no_hash = line.lstrip('#')
|
|
return no_hash.split('{', 1)[0].strip()
|
|
|
|
|
|
def build_nav_entry(root, args):
|
|
if root.endswith('images'):
|
|
return None, None, None
|
|
result_items = []
|
|
index_meta, index_content = util.read_md_file(os.path.join(root, 'index.md'))
|
|
current_title = index_meta.get('toc_folder_title', index_meta.get('toc_title', find_first_header(index_content)))
|
|
for filename in os.listdir(root):
|
|
path = os.path.join(root, filename)
|
|
if os.path.isdir(path):
|
|
prio, title, payload = build_nav_entry(path, args)
|
|
if title and payload:
|
|
result_items.append((prio, title, payload))
|
|
elif filename.endswith('.md'):
|
|
path = os.path.join(root, filename)
|
|
meta, content = util.read_md_file(path)
|
|
path = path.split('/', 2)[-1]
|
|
title = meta.get('toc_title', find_first_header(content))
|
|
if title:
|
|
title = title.strip().rstrip('.')
|
|
else:
|
|
title = meta.get('toc_folder_title', 'hidden')
|
|
prio = meta.get('toc_priority', 9999)
|
|
logging.debug(f'Nav entry: {prio}, {title}, {path}')
|
|
if not content.strip():
|
|
title = 'hidden'
|
|
if args.nav_limit and len(result_items) >= args.nav_limit:
|
|
break
|
|
result_items.append((prio, title, path))
|
|
result_items = sorted(result_items, key=lambda x: (x[0], x[1]))
|
|
result = collections.OrderedDict([(item[1], item[2]) for item in result_items])
|
|
return index_meta.get('toc_priority', 10000), current_title, result
|
|
|
|
|
|
def build_nav(lang, args):
|
|
docs_dir = os.path.join(args.docs_dir, lang)
|
|
_, _, nav = build_nav_entry(docs_dir, args)
|
|
result = []
|
|
index_key = None
|
|
for key, value in nav.items():
|
|
if key and value:
|
|
if value == 'index.md':
|
|
index_key = key
|
|
continue
|
|
result.append({key: value})
|
|
if args.nav_limit and len(result) >= args.nav_limit:
|
|
break
|
|
if index_key:
|
|
key = list(result[0].keys())[0]
|
|
result[0][key][index_key] = 'index.md'
|
|
result[0][key].move_to_end(index_key, last=False)
|
|
print('result', result)
|
|
return result
|
|
|
|
|
|
def _custom_get_navigation(files, config):
|
|
nav_config = config['nav'] or mkdocs.structure.nav.nest_paths(f.src_path for f in files.documentation_pages())
|
|
items = mkdocs.structure.nav._data_to_navigation(nav_config, files, config)
|
|
if not isinstance(items, list):
|
|
items = [items]
|
|
|
|
pages = mkdocs.structure.nav._get_by_type(items, mkdocs.structure.nav.Page)
|
|
|
|
mkdocs.structure.nav._add_previous_and_next_links(pages)
|
|
mkdocs.structure.nav._add_parent_links(items)
|
|
|
|
missing_from_config = [file for file in files.documentation_pages() if file.page is None]
|
|
if missing_from_config:
|
|
files._files = [file for file in files._files if file not in missing_from_config]
|
|
|
|
links = mkdocs.structure.nav._get_by_type(items, mkdocs.structure.nav.Link)
|
|
for link in links:
|
|
scheme, netloc, path, params, query, fragment = mkdocs.structure.nav.urlparse(link.url)
|
|
if scheme or netloc:
|
|
mkdocs.structure.nav.log.debug(
|
|
"An external link to '{}' is included in "
|
|
"the 'nav' configuration.".format(link.url)
|
|
)
|
|
elif link.url.startswith('/'):
|
|
mkdocs.structure.nav.log.debug(
|
|
"An absolute path to '{}' is included in the 'nav' configuration, "
|
|
"which presumably points to an external resource.".format(link.url)
|
|
)
|
|
else:
|
|
msg = (
|
|
"A relative path to '{}' is included in the 'nav' configuration, "
|
|
"which is not found in the documentation files".format(link.url)
|
|
)
|
|
mkdocs.structure.nav.log.warning(msg)
|
|
return mkdocs.structure.nav.Navigation(items, pages)
|
|
|
|
|
|
mkdocs.structure.nav.get_navigation = _custom_get_navigation
|