mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 08:24:40 +01:00
9fbecfc155
* feat: use github actions to deploy docs fixes #4473 * fix: install xonsh * fix: doc action * chore: support *.md for documentation * fix: remove hardcoded docs link it affects local testing * refactor: move sphinx extensions to its own package * fix: remove deprecated get_theme_dir As of Sphinx 1.2, this is passed to Sphinx via a ``setup.py`` entry point, and no longer needs to be included in your documentation's ``conf.py``. * feat: jinja2 render without affecting incremental build * style: * feat: auto generate API doc no need to create a file for each module * chore: watch top-level and nested files * refactor: update lib api-docs as well * fix: import errors when doc generated for some modules * fix: relative path * feat: add release handling * Update .github/workflows/docs.yml Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com> * refactor: use github-app-token * chore: deploy docs only when merged Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>
57 lines
1.6 KiB
Django/Jinja
57 lines
1.6 KiB
Django/Jinja
Environment Variables
|
|
=====================
|
|
The following displays information about the environment variables that
|
|
affect xonsh performance in some way. It also lists their default values, if
|
|
applicable.
|
|
|
|
{% set ns = namespace(root_index='') %}
|
|
{% set env_vars = make_envvars() %}
|
|
|
|
{% macro list_table(vars) %}
|
|
{% for vardoc in rst.iterator_for_divmod(vars.values()) %}
|
|
{% if loop.index0 % 3 == 0 %}* {% else %} {% endif %}- {% if vardoc %}{{ rst.to_ref_string(vardoc.info.title) }}{% endif %}
|
|
|
|
{% endfor %}
|
|
{% endmacro %}
|
|
|
|
{#titular table#}
|
|
{% for cls, envgrp in env_vars.children.items() recursive %}
|
|
{% if not loop.depth0 %}
|
|
{% set ns.root_index=loop.index %}
|
|
{% endif %}
|
|
|
|
.. list-table:: {{ rst.to_ref_string(cls.get_group_title()) }}
|
|
:header-rows: 0
|
|
|
|
{{ list_table(envgrp.vars)|indent(4) }}
|
|
{% if envgrp.children %}{{ loop(envgrp.children.items()) }}{% endif %}
|
|
{% endfor %}
|
|
|
|
{#variables doc#}
|
|
{% for cls, envgrp in env_vars.children.items() recursive %}
|
|
|
|
.. _{{ rst.to_valid_id(cls.get_group_title()) }}:
|
|
|
|
{{ cls.get_group_title() }}
|
|
{{ rst.underline_title(cls.get_group_title(), loop.depth0) }}
|
|
{{ cls.get_group_description() }}
|
|
|
|
{% for key, vardoc in envgrp.vars.items() %}
|
|
|
|
.. _{{ rst.to_valid_id(vardoc.info.title) }}:
|
|
|
|
{{ vardoc.info.title }}
|
|
{{ rst.underline_title(vardoc.info.title) }}
|
|
{{ vardoc.info.docstr }}
|
|
|
|
**configurable:** {{ vardoc.info.configurable }}
|
|
|
|
**default:** {{ vardoc.info.default }}
|
|
|
|
**store_as_str:** {{ vardoc.info.store_as_str }}
|
|
|
|
-------
|
|
{% endfor %}
|
|
|
|
{% if envgrp.children %}{{ loop(envgrp.children.items()) }}{% endif %}
|
|
{% endfor %}
|