flexmeasures.utils.doc_utils

Functions

flexmeasures.utils.doc_utils.rst_to_openapi(text: str) → str

Convert a string with RST markup to OpenAPI-safe text.

  • Replaces to some section with “the docs” and links in the docs with a search link

  • Replaces section A with “section A”, also adding the search link for “anchor”

  • Removes any RST footnote references like [#]_ or [1]_ or [label]

  • Converts external hyperlinks like text to HTML anchors:

    >>> rst_to_openapi("see `the S2 standard <https://docs.s2standard.org>`_ for details")
'see <a href="https://docs.s2standard.org" target="_blank" rel="noopener noreferrer">the S2 standard</a> for details'

  • Replaces X with <abbr title=”Y”>X</abbr>

  • Converts \(base^{exp}\) into HTML sup/sub notation for OpenAPI

  • Converts inline code to <code>

  • Converts bold to <strong>

  • Converts italic to <em>

  • Converts strings to just strings