Macros info
Macros Plugin Environment¶
General List¶
All available variables and filters within the macros plugin:
Variable | Type | Content |
---|---|---|
extra | dict | |
config | MkDocsConfig | {'config_file_path': '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io/mkdocs.yml', 'site_name': 'The Phoenix Chronobiology Projects', 'nav': [{'The Phoenix Chronobiology Projects': 'index.md'}, {'ABPM': 'abpm/index.md'}, {'Algorithms': [{'Algorithms': 'algorithms/index.md'}, {'COSINOR analysis': 'algorithms/cosinor.md'}, {'CUSUM analysis': 'algorithms/cusum.md'}]}, {'Biorhythm Platform': [{'Biorhythm Platform': 'biorhythm-platform/index.md'}, {'Requirements': [{'Requirements': 'biorhythm-platform/requirements/index.md'}]}, {'Conceptual Architecture': 'biorhythm-platform/conceptual-architecture.md'}, {'Privacy & security': [{'Privacy & security': 'biorhythm-platform/privacy-security/index.md'}, {'Security requirements': 'biorhythm-platform/privacy-security/security-requirements.md'}, {'Security architecture': 'biorhythm-platform/privacy-security/security-architecture.md'}, {'Threat assessment': 'biorhythm-platform/privacy-security/threat-assessment.md'}, {'Attack surface analysis': 'biorhythm-platform/privacy-security/attack-surface-analysis.md'}]}]}, {'Library': [{'Library': 'library/index.md'}, {'Design goals': 'library/design-goals.md'}, {'Quality goals': 'library/quality-goals.md'}, {'Old Project Archive ⧉': 'https://phoenix-chronobiology.github.io/hyde/'}]}, {'Glossary': 'glossary/index.md'}, {'About the site': [{'About the site': 'about/index.md'}, {'Macros info': 'about/macros-info.md'}]}], 'pages': None, 'exclude_docs': None, 'draft_docs': None, 'not_in_nav': This work © 2024 by CHRISTOPHER ADAMS is licensed under Attribution 4.0 International ⧉ ⧉ ', 'google_analytics': None, 'dev_addr': _IpAddressValue(host='127.0.0.1', port=8000), 'use_directory_urls': True, 'repo_url': 'https://github.com/phoenix-chronobiology/phoenix-chronobiology.github.io', 'repo_name': 'GitHub', 'edit_uri_template': None, 'edit_uri': 'edit/master/docs/', 'extra_css': ['stylesheets/hero-image.css', 'stylesheets/typeset.css'], 'extra_javascript': ['javascripts/mathjax.js', 'https://polyfill.io/v3/polyfill.min.js?features=es6', 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js', {'path': 'https://unpkg.com/mermaid@10/dist/mermaid.min.js', 'type': '', 'defer': False, 'async': False}], 'extra_templates': [], 'markdown_extensions': ['toc', 'tables', 'fenced_code', 'markdown.extensions.admonition', 'markdown.extensions.attr_list', 'markdown.extensions.def_list', 'markdown.extensions.footnotes', 'markdown.extensions.md_in_html', 'markdown.extensions.meta', 'markdown.extensions.tables', 'markdown.extensions.toc', 'pymdownx.arithmatex', 'pymdownx.blocks.tab', 'pymdownx.caret', 'pymdownx.emoji', 'pymdownx.highlight', 'pymdownx.mark', 'pymdownx.smartsymbols', 'pymdownx.snippets', 'pymdownx.superfences', 'pymdownx.tasklist', 'pymdownx.tilde'], 'mdx_configs': {'markdown.extensions.toc': {'permalink': True, 'slugify': functools.partial( |
environment | dict | system = 'MacOs', system_version = '14.4.1', python_version = '3.12.3', mkdocs_version = '1.6.0', macros_plugin_version = '1.0.5', jinja2_version = '3.1.4' |
plugin | LegacyConfig | {'module_name': 'main', 'modules': [], 'render_by_default': True, 'include_dir': '', 'include_yaml': [], '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 = '1cf857f', commit = '1cf857f3e6737d373f87c8c8231836174b9580eb', tag = '', short_tag = '', author = 'Chris Adams', author_email = '155780943+cadams4341@users.noreply.github.com', committer = 'Chris Adams', committer_email = '155780943+cadams4341@users.noreply.github.com', date_ISO = 'Sun May 19 11:01:48 2024 -0500', message = 'adjust banners and add admonitions to highlight work remaining', raw = 'commit 1cf857f3e6737d373f87c8c8231836174b9580eb\nAuthor: Chris Adams <155780943+cadams4341@users.noreply.github.com>\nDate: Sun May 19 11:01:48 2024 -0500\n\n adjust banners and add admonitions to highlight work remaining', root_dir = '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io' |
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='Macros info', url='about/macros-info/') |
Config Information¶
Standard MkDocs configuration information. Do not try to modify.
e.g. {{ config.docs_dir }}
See also the MkDocs documentation on the config object ⧉.
Variable | Type | Content |
---|---|---|
config_file_path | str | '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io/mkdocs.yml' |
site_name | str | 'The Phoenix Chronobiology Projects' |
nav | list | [{'The Phoenix Chronobiology Projects': 'index.md'}, {'ABPM': 'abpm/index.md'}, {'Algorithms': [{'Algorithms': 'algorithms/index.md'}, {'COSINOR analysis': 'algorithms/cosinor.md'}, {'CUSUM analysis': 'algorithms/cusum.md'}]}, {'Biorhythm Platform': [{'Biorhythm Platform': 'biorhythm-platform/index.md'}, {'Requirements': [{'Requirements': 'biorhythm-platform/requirements/index.md'}]}, {'Conceptual Architecture': 'biorhythm-platform/conceptual-architecture.md'}, {'Privacy & security': [{'Privacy & security': 'biorhythm-platform/privacy-security/index.md'}, {'Security requirements': 'biorhythm-platform/privacy-security/security-requirements.md'}, {'Security architecture': 'biorhythm-platform/privacy-security/security-architecture.md'}, {'Threat assessment': 'biorhythm-platform/privacy-security/threat-assessment.md'}, {'Attack surface analysis': 'biorhythm-platform/privacy-security/attack-surface-analysis.md'}]}]}, {'Library': [{'Library': 'library/index.md'}, {'Design goals': 'library/design-goals.md'}, {'Quality goals': 'library/quality-goals.md'}, {'Old Project Archive ⧉': 'https://phoenix-chronobiology.github.io/hyde/'}]}, {'Glossary': 'glossary/index.md'}, {'About the site': [{'About the site': 'about/index.md'}, {'Macros info': 'about/macros-info.md'}]}] |
pages | NoneType | None |
exclude_docs | NoneType | None |
draft_docs | NoneType | None |
not_in_nav | GitIgnoreSpec | |
site_url | NoneType | None |
site_description | NoneType | None |
site_author | str | 'Christopher Adams' |
theme | Theme | Theme(name='material', dirs=['/Library/Frameworks/Python.framework/Versions/3.12/lib/python3.12/site-packages/material/templates', '/Library/Frameworks/Python.framework/Versions/3.12/lib/python3.12/site-packages/mkdocs/templates'], static_templates={'404.html', 'sitemap.xml'}, name='material', locale=Locale('en'), language='en', direction=None, features=['navigation.footer', 'navigation.indexes', 'navigation.instant', 'navigation.instant.progress', 'navigation.tabs', 'navigation.tabs.sticky', 'navigation.top', 'toc.follow'], font={'text': 'Cabin', 'code': 'Ubuntu Mono'}, icon=None, favicon='images/circadian-rhythms-32x32.png', logo='images/phoenix-mark-white.png', palette=[{'media': '(prefers-color-scheme)', 'toggle': {'icon': 'material/brightness-auto', 'name': 'Switch to light mode'}}, {'media': '(prefers-color-scheme: light)', 'scheme': 'default', 'primary': 'blue grey', 'accent': 'indigo', 'toggle': {'icon': 'material/brightness-7', 'name': 'Switch to dark mode'}}, {'media': '(prefers-color-scheme: dark)', 'scheme': 'slate', 'primary': 'blue grey', 'accent': 'indigo', 'toggle': {'icon': 'material/brightness-4', 'name': 'Switch to system preference'}}]) |
docs_dir | str | '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io/docs' |
site_dir | str | '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io/site' |
copyright | str | ' This work © 2024 by CHRISTOPHER ADAMS is licensed under Attribution 4.0 International ⧉ ⧉ ' |
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/phoenix-chronobiology/phoenix-chronobiology.github.io' |
repo_name | str | 'GitHub' |
edit_uri_template | NoneType | None |
edit_uri | str | 'edit/master/docs/' |
extra_css | list | ['stylesheets/hero-image.css', 'stylesheets/typeset.css'] |
extra_javascript | list | ['javascripts/mathjax.js', 'https://polyfill.io/v3/polyfill.min.js?features=es6', 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js', {'path': 'https://unpkg.com/mermaid@10/dist/mermaid.min.js', 'type': '', 'defer': False, 'async': False}] |
extra_templates | list | [] |
markdown_extensions | list | ['toc', 'tables', 'fenced_code', 'markdown.extensions.admonition', 'markdown.extensions.attr_list', 'markdown.extensions.def_list', 'markdown.extensions.footnotes', 'markdown.extensions.md_in_html', 'markdown.extensions.meta', 'markdown.extensions.tables', 'markdown.extensions.toc', 'pymdownx.arithmatex', 'pymdownx.blocks.tab', 'pymdownx.caret', 'pymdownx.emoji', 'pymdownx.highlight', 'pymdownx.mark', 'pymdownx.smartsymbols', 'pymdownx.snippets', 'pymdownx.superfences', 'pymdownx.tasklist', 'pymdownx.tilde'] |
mdx_configs | dict | markdown.extensions.toc [dict], pymdownx.arithmatex [dict], pymdownx.blocks.tab [dict], pymdownx.emoji [dict], pymdownx.tasklist [dict] |
strict | bool | False |
remote_branch | str | 'gh-pages' |
remote_name | str | 'origin' |
extra | LegacyConfig | {} |
plugins | PluginCollection | exclude [Exclude], git-revision-date-localized [GitRevisionDateLocalizedPlugin], link-marker [LinkMarkerPlugin], macros [MacrosPlugin], material/privacy [PrivacyPlugin], material/search [SearchPlugin] |
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, 'anchors': 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 |
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, 5, 19, 11, 1, 48, tzinfo=tzoffset(None, -18000)) |
short_commit | str | '1cf857f' |
commit | str | '1cf857f3e6737d373f87c8c8231836174b9580eb' |
tag | str | '' |
short_tag | str | '' |
author | str | 'Chris Adams' |
author_email | str | '155780943+cadams4341@users.noreply.github.com' |
committer | str | 'Chris Adams' |
committer_email | str | '155780943+cadams4341@users.noreply.github.com' |
date_ISO | str | 'Sun May 19 11:01:48 2024 -0500' |
message | str | 'adjust banners and add admonitions to highlight work remaining' |
raw | str | 'commit 1cf857f3e6737d373f87c8c8231836174b9580eb\nAuthor: Chris Adams <155780943+cadams4341@users.noreply.github.com>\nDate: Sun May 19 11:01:48 2024 -0500\n\n adjust banners and add admonitions to highlight work remaining' |
root_dir | str | '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io' |
Page Attributes¶
Provided by MkDocs. These attributes change for every page (the attributes shown are for this page).
e.g. {{ page.title }}
See also the MkDocs documentation on the page object ⧉.
Variable | Type | Content |
---|---|---|
file | File | src_uri = 'about/macros-info.md', src_dir = '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io/docs', dest_dir = '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io/site', use_directory_urls = True, inclusion [InclusionLevel], name = 'macros-info', dest_uri = 'about/macros-info/index.html', page [Page], url = 'about/macros-info/', abs_src_path = '/Users/runner/work/phoenix-chronobiology.github.io/phoenix-chronobiology.github.io/docs/about/macros-info.md' |
title | str | 'Macros info' |
children | NoneType | None |
previous_page | Page | Page(title='About the site', url='about/') |
next_page | NoneType | None |
_Page__active | bool | False |
update_date | str | '2024-05-19' |
canonical_url | NoneType | None |
abs_url | NoneType | None |
edit_url | str | 'https://github.com/phoenix-chronobiology/phoenix-chronobiology.github.io/edit/master/docs/about/macros-info.md' |
markdown | str | '{{ macros_info() }}\n' |
_title_from_render | NoneType | None |
content | NoneType | None |
toc | list | [] |
meta | dict | git_revision_date_localized = '2024-05-19 11:01:48-0500 (CDT)', git_revision_date_localized_raw_date = 'May 19, 2024', git_revision_date_localized_raw_datetime = 'May 19, 2024 11:01:48', git_revision_date_localized_raw_iso_date = '2024-05-19', git_revision_date_localized_raw_iso_datetime = '2024-05-19 11:01:48', git_revision_date_localized_raw_timeago = '', git_revision_date_localized_raw_custom = '2024-05-19 11:01:48-0500 (CDT)', git_site_revision_date_localized = '2024-05-19 11:01:48-0500 (CDT)', git_site_revision_date_localized_raw_date = 'May 19, 2024', git_site_revision_date_localized_raw_datetime = 'May 19, 2024 11:01:48', git_site_revision_date_localized_raw_iso_date = '2024-05-19', git_site_revision_date_localized_raw_iso_datetime = '2024-05-19 11:01:48', git_site_revision_date_localized_raw_timeago = '', git_site_revision_date_localized_raw_custom = '2024-05-19 11:01:48-0500 (CDT)' |
parent | Section | title = 'About the site', children = [Page(title='About the site', url='about/'), Page(title='Macros info', url='about/macros-info/')], _Section__active = False |
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.
See also the Jinja2 documentation on builtin filters ⧉).
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. |
batch | function | (value, linecount, fill_with, tmp, item) A filter that batches items. It works pretty much like |
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 |
escape | builtin_function_or_method | Replace the characters |
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 |
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 |
forceescape | function | (value) Enforce HTML escaping. This will probably double escape variables. |
format | function | (value, args, kwargs) Apply the given values to a |
groupby | function | (args, kwargs, b) Group a sequence of objects by an attribute using Python's :func: |
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 |
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 |
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 |
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 |
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: |
string | builtin_function_or_method | Convert an object to a string if it isn't already. This preserves a :class: |
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 |
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, items, key, value, rv) Create an SGML/XML attribute string based on the items in a dict. |
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. |