Macros

config#

Variable Type Content
config_file_path str 'mkdocs.yml'
site_name str 'HGVS Nomenclature'
nav NoneType None
pages NoneType None
exclude_docs GitIgnoreSpec
draft_docs NoneType None
not_in_nav NoneType None
site_url str 'https://hgvs-nomenclature.org/'
site_description NoneType None
site_author NoneType None
theme Theme Theme(name='material', dirs=['overrides', '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/envs/21.1.0/lib/python3.12/site-packages/material/templates', '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/envs/21.1.0/lib/python3.12/site-packages/mkdocs/templates'], static_templates={'sitemap.xml', '404.html'}, name='material', locale=Locale('en'), language='en', direction=None, features=['announce.dismiss', 'navigation.indexes', 'navigation.instant', 'navigation.tracking', 'search.highlight', 'toc.follow', 'toc.integrate'], font={'text': 'Lato', 'code': 'Roboto Mono'}, icon=None, favicon='images/hgvs-logo.png', palette=[{'media': '(prefers-color-scheme: light)', 'scheme': 'hvnc', 'toggle': {'icon': 'material/brightness-7', 'name': 'Switch to dark mode'}}, {'media': '(prefers-color-scheme: dark)', 'scheme': 'slate', 'toggle': {'icon': 'material/brightness-4', 'name': 'Switch to light mode'}}], logo='images/hgvs-logo.png')
docs_dir str '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0/docs'
site_dir str '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0/_readthedocs/html'
copyright str 'CC0 1.0 Universal by HGVS Nomenclature Contributors'
google_analytics NoneType None
dev_addr _IpAddressValue _IpAddressValue(host='127.0.0.1', port=8000)
use_directory_urls bool True
repo_url str 'https://github.com/HGVSNomenclature/hgvs-nomenclature'
repo_name str 'GitHub'
edit_uri_template NoneType None
edit_uri str 'edit/master/docs/'
extra_css list ['stylesheets/extra.css']
extra_javascript list []
extra_templates list []
markdown_extensions list ['toc', 'tables', 'fenced_code', 'abbr', 'admonition', 'attr_list', 'def_list', 'markdown_captions', 'pymdownx.details', 'pymdownx.magiclink', 'pymdownx.superfences']
mdx_configs dict toc [dict], pymdownx.superfences [dict]
strict bool False
remote_branch str 'gh-pages'
remote_name str 'origin'
extra LegacyConfig {'analytics': {'provider': 'google', 'property': 'G-EJ2MT1N34E'}, 'social': [{'icon': 'fontawesome/brands/github', 'link': 'https://github.com/HGVSNomenclature/hgvs-nomenclature'}]}
plugins PluginCollection awesome-pages [AwesomePagesPlugin], markdown-exec [MarkdownExecPlugin], material/search [SearchPlugin], mkdocs-simple-hooks [SimpleHooksPlugin], macros [MacrosPlugin], table-reader [TableReaderPlugin], hooks.py [module]
hooks dict hooks.py [module]
watch list ['/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0/bin', '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0/lib', '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0/overrides', '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0/overrides/partials', '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0/hooks.py']
validation Validation {'nav': {'omitted_files': 30, 'not_found': 30, 'absolute_links': 30}, 'links': {'not_found': 30, 'absolute_links': 30, 'unrecognized_links': 30, 'anchors': 20}}

environment#

Variable Type Content
system str 'Linux'
system_version str '5.19.0-1028-aws'
python_version str '3.12.3'
mkdocs_version str '1.6.1'
macros_plugin_version str '1.3.7'
jinja2_version str '3.1.4'

git#

Variable Type Content
status bool True
date datetime datetime.datetime(2024, 11, 15, 19, 36, 40, tzinfo=tzoffset(None, -28800))
short_commit str 'f86c5bc'
commit str 'f86c5bc94acb86d31d0316b63e1d2dc80fdb3797'
tag str '21.1.0'
short_tag str '21.1.0'
author str 'Reece Hart'
author_email str 'reecehart@gmail.com'
committer str 'Reece Hart'
committer_email str 'reecehart@gmail.com'
date_ISO str 'Fri Nov 15 19:36:40 2024 -0800'
message str 'add stub version files to prevent mkdocs page navigation errors'
raw str 'commit f86c5bc94acb86d31d0316b63e1d2dc80fdb3797\nAuthor: Reece Hart \nDate: Fri Nov 15 19:36:40 2024 -0800\n\n add stub version files to prevent mkdocs page navigation errors'
root_dir str '/home/docs/checkouts/readthedocs.org/user_builds/hgvs-nomenclature/checkouts/21.1.0'