Skip to content
Snippets Groups Projects
Select Git revision
  • dualcore
  • ch3/leds
  • wip-bootstrap default
  • ch3/time
  • master
5 results

conf.py

Blame
    • Paul Sokolovsky's avatar
      ba33c544
      docs/conf.py: Set default_role = 'any'. · ba33c544
      Paul Sokolovsky authored
      This causes `symbol` syntax to be equivalent to :any:`symbol`, which is
      in turn the easiest way to cross-reference an arbitrary symbol in the
      docs:
      
      http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any
      
      :any: requires at least Sphinx 1.3 (for reference, Ubuntu 16.03 ships
      with 1.3.6, the latest 1.6.3).
      
      Any many of our docs, `symbol` is misused to specify arguments to
      functions, etc. Refactoring that is in progress. (CODECONVENTIONS
      already specify proper syntax for both arguments and xrefs, based
      on CPython conventions).
      ba33c544
      History
      docs/conf.py: Set default_role = 'any'.
      Paul Sokolovsky authored
      This causes `symbol` syntax to be equivalent to :any:`symbol`, which is
      in turn the easiest way to cross-reference an arbitrary symbol in the
      docs:
      
      http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any
      
      :any: requires at least Sphinx 1.3 (for reference, Ubuntu 16.03 ships
      with 1.3.6, the latest 1.6.3).
      
      Any many of our docs, `symbol` is misused to specify arguments to
      functions, etc. Refactoring that is in progress. (CODECONVENTIONS
      already specify proper syntax for both arguments and xrefs, based
      on CPython conventions).