Info on mkdocs site configuration

Macros Plugin Environment

General List

All available variables and filters within the macros plugin:

Variable	Type	Content
extra	dict
config	MkDocsConfig	{'config_file_path': '/group/datalabgrp/ctbrown/slainte-shya/mkdocs.yml', 'site_name': 'sourmash slainte', 'nav': None, 'pages': None, 'exclude_docs': None, 'not_in_nav': None, 'site_url': None, 'site_description': None, 'site_author': None, 'theme': Theme(name='material', dirs=['/home/ctbrown/mambaforge/envs/slainte/lib/python3.12/site-packages/material/templates', '/home/ctbrown/mambaforge/envs/slainte/lib/python3.12/site-packages/mkdocs/templates'], static_templates={'sitemap.xml', '404.html'}, name='material', locale=Locale('en'), language='en', direction=None, features=[], font={'text': 'Roboto', 'code': 'Roboto Mono'}, icon=None, favicon='assets/images/favicon.png'), 'docs_dir': '/group/datalabgrp/ctbrown/slainte-shya/docs', 'site_dir': '/group/datalabgrp/ctbrown/slainte-shya/site', 'copyright': None, 'google_analytics': None, 'dev_addr': _IpAddressValue(host='127.0.0.1', port=8000), 'use_directory_urls': True, 'repo_url': None, 'repo_name': None, 'edit_uri_template': None, 'edit_uri': None, 'extra_css': [], 'extra_javascript': [], 'extra_templates': [], 'markdown_extensions': ['toc', 'tables', 'fenced_code', 'admonition', 'pymdownx.details', 'pymdownx.superfences', 'pymdownx.tasklist'], 'mdx_configs': {'pymdownx.tasklist': {'custom_checkbox': True, 'clickable_checkbox': True}}, 'strict': False, 'remote_branch': 'gh-pages', 'remote_name': 'origin', 'extra': {}, 'plugins': {'material/search': , 'table-reader': , 'macros': }, 'hooks': {}, 'watch': [], 'validation': {'nav': {'omitted_files': 20, 'not_found': 30, 'absolute_links': 20}, 'links': {'not_found': 30, 'absolute_links': 20, 'unrecognized_links': 20}}}
metagenome_dir	str	'/home/ctbrown/scratch3/shya-david-data'
sample_info	str	'samples.csv'
display_genomes	bool	True
genomes	list	['/home/ctbrown/scratch3/shya-david-genomes/*.gz']
databases	list	['/group/ctbrowngrp/sourmash-db/gtdb-rs214/gtdb-rs214-k21.zip']
taxonomies	list	['/group/ctbrowngrp/sourmash-db/gtdb-rs214/gtdb-rs214.lineages.csv']
environment	dict	system = 'Linux', system_version = '6.2.0-34-generic', python_version = '3.12.1 \| packaged by conda-forge \|', mkdocs_version = '1.5.3', macros_plugin_version = '1.0.5', jinja2_version = '3.1.2'
plugin	LegacyConfig	{'module_name': 'main', 'modules': [], 'render_by_default': True, 'include_dir': '', 'include_yaml': ['config.yml'], 'j2_block_start_string': '', 'j2_block_end_string': '', 'j2_variable_start_string': '', 'j2_variable_end_string': '', 'on_undefined': 'keep', 'on_error_fail': False, 'verbose': False}
git	dict	status = True, date [datetime], short_commit = 'd341cfe', commit = 'd341cfe6861d9e3d94c224e0914a562c2ae2356c', tag = '', short_tag = '', author = 'C. Titus Brown', author_email = 'titus@idyll.org', committer = 'C. Titus Brown', committer_email = 'titus@idyll.org', date_ISO = 'Mon Jan 1 06:25:07 2024 -0800', message = "Merge branch 'shya' into mkdocs", raw = "commit d341cfe6861d9e3d94c224e0914a562c2ae2356c\nMerge: b649a14 e53b786\nAuthor: C. Titus Brown \nDate: Mon Jan 1 06:25:07 2024 -0800\n\n Merge branch 'shya' into mkdocs", root_dir = '/group/datalabgrp/ctbrown/slainte-shya'
macros	SuperDict	context [function], macros_info [function], now [function], fix_url [function]
filters	dict	pretty [function]
filters_builtin	dict	abs [builtin_function_or_method], attr [function], batch [function], capitalize [function], center [function], count [builtin_function_or_method], d [function], default [function], dictsort [function], e [builtin_function_or_method], escape [builtin_function_or_method], filesizeformat [function], first [function], float [function], forceescape [function], format [function], groupby [function], indent [function], int [function], join [function], last [function], length [builtin_function_or_method], list [function], lower [function], items [function], map [function], min [function], max [function], pprint [function], random [function], reject [function], rejectattr [function], replace [function], reverse [function], round [function], safe [function], select [function], selectattr [function], slice [function], sort [function], string [builtin_function_or_method], striptags [function], sum [function], title [function], trim [function], truncate [function], unique [function], upper [function], urlencode [function], urlize [function], wordcount [function], wordwrap [function], xmlattr [function], tojson [function]
navigation	Navigation
files	Files
page	Page	Page(title='Info on mkdocs site configuration', url='macros_info/')

Config Information

Standard MkDocs configuration information. Do not try to modify.

e.g. {{ config.docs_dir }}

Variable	Type	Content
config_file_path	str	'/group/datalabgrp/ctbrown/slainte-shya/mkdocs.yml'
site_name	str	'sourmash slainte'
nav	NoneType	None
pages	NoneType	None
exclude_docs	NoneType	None
not_in_nav	NoneType	None
site_url	NoneType	None
site_description	NoneType	None
site_author	NoneType	None
theme	Theme	Theme(name='material', dirs=['/home/ctbrown/mambaforge/envs/slainte/lib/python3.12/site-packages/material/templates', '/home/ctbrown/mambaforge/envs/slainte/lib/python3.12/site-packages/mkdocs/templates'], static_templates={'sitemap.xml', '404.html'}, name='material', locale=Locale('en'), language='en', direction=None, features=[], font={'text': 'Roboto', 'code': 'Roboto Mono'}, icon=None, favicon='assets/images/favicon.png')
docs_dir	str	'/group/datalabgrp/ctbrown/slainte-shya/docs'
site_dir	str	'/group/datalabgrp/ctbrown/slainte-shya/site'
copyright	NoneType	None
google_analytics	NoneType	None
dev_addr	_IpAddressValue	_IpAddressValue(host='127.0.0.1', port=8000)
use_directory_urls	bool	True
repo_url	NoneType	None
repo_name	NoneType	None
edit_uri_template	NoneType	None
edit_uri	NoneType	None
extra_css	list	[]
extra_javascript	list	[]
extra_templates	list	[]
markdown_extensions	list	['toc', 'tables', 'fenced_code', 'admonition', 'pymdownx.details', 'pymdownx.superfences', 'pymdownx.tasklist']
mdx_configs	dict	pymdownx.tasklist [dict]
strict	bool	False
remote_branch	str	'gh-pages'
remote_name	str	'origin'
extra	LegacyConfig	{}
plugins	PluginCollection	material/search [SearchPlugin], table-reader [TableReaderPlugin], macros [MacrosPlugin]
hooks	dict
watch	list	[]
validation	Validation	{'nav': {'omitted_files': 20, 'not_found': 30, 'absolute_links': 20}, 'links': {'not_found': 30, 'absolute_links': 20, 'unrecognized_links': 20}}

Macros

These macros have been defined programmatically for this environment (module or pluglets).

Variable	Type	Content
context	function	(obj, var, value, e) Default mkdocs_macro List the defined variables
macros_info	function	() Test/debug function: list useful documentation on the mkdocs_macro environment.
now	function	() Get the current time (returns a datetime object). Used alone, it provides a timestamp. To get the year use `now().year`, for the month number `now().month`, etc.
fix_url	function	(url, r) If url is relative, fix it so that it points to the docs diretory. This is necessary because relative links in markdown must be adapted in html ('img/foo.png' => '../img/img.png').

Git Information

Information available on the last commit and the git repository containing the documentation project:

e.g. {{ git.message }}

Variable	Type	Content
status	bool	True
date	datetime	datetime.datetime(2024, 1, 1, 6, 25, 7, tzinfo=tzoffset(None, -28800))
short_commit	str	'd341cfe'
commit	str	'd341cfe6861d9e3d94c224e0914a562c2ae2356c'
tag	str	''
short_tag	str	''
author	str	'C. Titus Brown'
author_email	str	'titus@idyll.org'
committer	str	'C. Titus Brown'
committer_email	str	'titus@idyll.org'
date_ISO	str	'Mon Jan 1 06:25:07 2024 -0800'
message	str	"Merge branch 'shya' into mkdocs"
raw	str	"commit d341cfe6861d9e3d94c224e0914a562c2ae2356c\nMerge: b649a14 e53b786\nAuthor: C. Titus Brown \nDate: Mon Jan 1 06:25:07 2024 -0800\n\n Merge branch 'shya' into mkdocs"
root_dir	str	'/group/datalabgrp/ctbrown/slainte-shya'

Page Attributes

Provided by MkDocs. These attributes change for every page (the attributes shown are for this page).

e.g. {{ page.title }}

Variable	Type	Content
file	File	page [Page], src_uri = 'macros_info.md', name = 'macros_info', dest_uri = 'macros_info/index.html', url = 'macros_info/', abs_src_path = '/group/datalabgrp/ctbrown/slainte-shya/docs/macros_info.md', abs_dest_path = '/group/datalabgrp/ctbrown/slainte-shya/site/macros_info/index.html', inclusion [InclusionLevel]
children	NoneType	None
previous_page	Page	Page(title='Genome comparisons', url='genome_compare/')
next_page	Page	Page(title=[blank], url='metag_compare/')
_Page__active	bool	False
update_date	str	'2024-01-23'
canonical_url	NoneType	None
abs_url	NoneType	None
edit_url	NoneType	None
markdown	str	'# Info on mkdocs site configuration\n\n{{ macros_info() }}\n'
_title_from_render	NoneType	None
content	NoneType	None
toc	list	[]
meta	dict

To have all titles of all pages, use:

{% for page in navigation.pages %}
- {{ page.title }}
{% endfor %}

Plugin Filters

These filters are provided as a standard by the macros plugin.

Variable	Type	Content
pretty	function	(var_list, var, var_type, content, rows, header, e) Default mkdocs_macro Prettify a dictionary or object (used for environment documentation, or debugging).

Builtin Jinja2 Filters

These filters are provided by Jinja2 as a standard.

Variable	Type	Content
abs	builtin_function_or_method	Return the absolute value of the argument.
attr	function	(environment, obj, name, value) Get an attribute of an object. `foo\|attr("bar")` works like `foo.bar` just that always an attribute is returned and items are not looked up.
batch	function	(value, linecount, fill_with, tmp, item) A filter that batches items. It works pretty much like `slice` just the other way round. It returns a list of lists with the given number of items. If you provide a second parameter this is used to fill up missing items. See this example.
capitalize	function	(s) Capitalize a value. The first character will be uppercase, all others lowercase.
center	function	(value, width) Centers the value in a field of a given width.
count	builtin_function_or_method	Return the number of items in a container.
d	function	(value, default_value, boolean) If the value is undefined it will return the passed default value, otherwise the value of the variable.
default	function	(value, default_value, boolean) If the value is undefined it will return the passed default value, otherwise the value of the variable.
dictsort	function	(value, case_sensitive, by, reverse, sort_func) Sort a dict and yield (key, value) pairs. Python dicts may not be in the order you want to display them in, so sort them first.
e	builtin_function_or_method	Replace the characters `&`, `<`, `>`, `'`, and `"` in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML.
escape	builtin_function_or_method	Replace the characters `&`, `<`, `>`, `'`, and `"` in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML.
filesizeformat	function	(value, binary, bytes, base, prefixes, i, prefix, unit) Format the value like a 'human-readable' file size (i.e. 13 kB, 4.1 MB, 102 Bytes, etc). Per default decimal prefixes are used (Mega, Giga, etc.), if the second parameter is set to `True` the binary prefixes are used (Mebi, Gibi).
first	function	(args, kwargs, b) Return the first item of a sequence.
float	function	(value, default) Convert the value into a floating point number. If the conversion doesn't work it will return `0.0`. You can override this default using the first parameter.
forceescape	function	(value) Enforce HTML escaping. This will probably double escape variables.
format	function	(value, args, kwargs) Apply the given values to a `printf-style`_ format string, like `string % values`.
groupby	function	(args, kwargs, b) Group a sequence of objects by an attribute using Python's :func:`itertools.groupby`. The attribute can use dot notation for nested access, like `"address.city"`. Unlike Python's `groupby`, the values are sorted first so only one group is returned for each unique value.
indent	function	(s, width, first, blank, newline, rv, lines) Return a copy of the string with each line indented by 4 spaces. The first line and blank lines are not indented by default.
int	function	(value, default, base) Convert the value into an integer. If the conversion doesn't work it will return `0`. You can override this default using the first parameter. You can also override the default base (10) in the second parameter, which handles input with prefixes such as 0b, 0o and 0x for bases 2, 8 and 16 respectively. The base is ignored for decimal numbers and non-string values.
join	function	(args, kwargs, b) Return a string which is the concatenation of the strings in the sequence. The separator between elements is an empty string per default, you can define it with the optional parameter.
last	function	(environment, seq) Return the last item of a sequence.
length	builtin_function_or_method	Return the number of items in a container.
list	function	(args, kwargs, b) Convert the value into a list. If it was a string the returned list will be a list of characters.
lower	function	(s) Convert a value to lowercase.
items	function	(value) Return an iterator over the `(key, value)` items of a mapping.
map	function	(args, kwargs, b) Applies a filter on a sequence of objects or looks up an attribute. This is useful when dealing with lists of objects but you are really only interested in a certain value of it.
min	function	(environment, value, case_sensitive, attribute) Return the smallest item from the sequence.
max	function	(environment, value, case_sensitive, attribute) Return the largest item from the sequence.
pprint	function	(value) Pretty print a variable. Useful for debugging.
random	function	(context, seq) Return a random item from the sequence.
reject	function	(args, kwargs, b) Filters a sequence of objects by applying a test to each object, and rejecting the objects with the test succeeding.
rejectattr	function	(args, kwargs, b) Filters a sequence of objects by applying a test to the specified attribute of each object, and rejecting the objects with the test succeeding.
replace	function	(eval_ctx, s, old, new, count) Return a copy of the value with all occurrences of a substring replaced with a new one. The first argument is the substring that should be replaced, the second is the replacement string. If the optional third argument `count` is given, only the first `count` occurrences are replaced.
reverse	function	(value, rv, e) Reverse the object or return an iterator that iterates over it the other way round.
round	function	(value, precision, method, func) Round the number to a given precision. The first parameter specifies the precision (default is `0`), the second the rounding method.
safe	function	(value) Mark the value as safe which means that in an environment with automatic escaping enabled this variable will not be escaped.
select	function	(args, kwargs, b) Filters a sequence of objects by applying a test to each object, and only selecting the objects with the test succeeding.
selectattr	function	(args, kwargs, b) Filters a sequence of objects by applying a test to the specified attribute of each object, and only selecting the objects with the test succeeding.
slice	function	(args, kwargs, b) Slice an iterator and return a list of lists containing those items. Useful if you want to create a div containing three ul tags that represent columns.
sort	function	(environment, value, reverse, case_sensitive, attribute, key_func) Sort an iterable using Python's :func:`sorted`.
string	builtin_function_or_method	Convert an object to a string if it isn't already. This preserves a :class:`Markup` string rather than converting it back to a basic string, so it will still be marked as safe and won't be escaped again.
striptags	function	(value) Strip SGML/XML tags and replace adjacent whitespace by one space.
sum	function	(args, kwargs, b) Returns the sum of a sequence of numbers plus the value of parameter 'start' (which defaults to 0). When the sequence is empty it returns start.
title	function	(s, item) Return a titlecased version of the value. I.e. words will start with uppercase letters, all remaining characters are lowercase.
trim	function	(value, chars) Strip leading and trailing characters, by default whitespace.
truncate	function	(env, s, length, killwords, end, leeway, result) Return a truncated copy of the string. The length is specified with the first parameter which defaults to `255`. If the second parameter is `true` the filter will cut the text at length. Otherwise it will discard the last word. If the text was in fact truncated it will append an ellipsis sign (`"..."`). If you want a different ellipsis sign than `"..."` you can specify it using the third parameter. Strings that only exceed the length by the tolerance margin given in the fourth parameter will not be truncated.
unique	function	(environment, value, case_sensitive, attribute, getter, seen, item, key) Returns a list of unique items from the given iterable.
upper	function	(s) Convert a value to uppercase.
urlencode	function	(value, items) Quote data for use in a URL path or query using UTF-8.
urlize	function	(eval_ctx, value, trim_url_limit, nofollow, target, rel, extra_schemes, policies, rel_parts, scheme, rv) Convert URLs in text into clickable links.
wordcount	function	(s) Count the words in that string.
wordwrap	function	(environment, s, width, break_long_words, wrapstring, break_on_hyphens, textwrap, line) Wrap a string to the given width. Existing newlines are treated as paragraphs to be wrapped separately.
xmlattr	function	(eval_ctx, d, autospace, rv) Create an SGML/XML attribute string based on the items in a dict. All values that are neither `none` nor `undefined` are automatically escaped.
tojson	function	(eval_ctx, value, indent, policies, dumps, kwargs) Serialize an object to a string of JSON, and mark it safe to render in HTML. This filter is only for use in HTML documents.