Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use :envvar: to refer to variables. (was: Updated to Sphinx 1.3 to allow using :any: to reference vars) #140

Merged
merged 2 commits into from
May 23, 2016
Merged

Use :envvar: to refer to variables. (was: Updated to Sphinx 1.3 to allow using :any: to reference vars) #140

merged 2 commits into from
May 23, 2016

Commits on May 23, 2016

  1. Run ./patch_gitmodules to ignore untracked files in submodules.

    @ypid
    ypid committed May 23, 2016
    Configuration menu
    Copy the full SHA
    23009dd View commit details
    Browse the repository at this point in the history

  2. Updated to Sphinx 1.3 to allow using :any: to reference vars. 

    Refer to the [Sphinx documentation about `:any:`](http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any)
`:any:` can be used in Sphinx to reference variables. Example:

```YAML
ferm__enabled: True

ferm__flush: '{{ ferm__enabled | bool }}'
```

When using this, we might need to adjust sections names. Example:

```reStructuredText
.. _ferm_input_list:

ferm_input_list
---------------
```

could be changed to:

```reStructuredText
.. _ferm_detailed_input_list:

ferm_input_list
---------------
```

1.3.4 has been chosen because it is the current version in [jessie-backports](https://packages.debian.org/jessie-backports/python-sphinx).
    @ypid
    ypid committed May 23, 2016
    Configuration menu
    Copy the full SHA
    7bd61cb View commit details
    Browse the repository at this point in the history