Sphinx docstrings examples

Handsdown API Index / Examples / Sphinx docstrings examples

Auto-generated documentation for examples.sphinx_docstrings module.

RSTExample

class RSTExample:
    ...

Test for some random Sphinx directives

def sum_eq_n?(arr, n)
    return true if arr.empty? && n == 0
    arr.product(arr).reject { |a,b| a == b }.any? { |a,b| a + b == n }
end

short note

(a + b)^2 = a^2 + 2ab + b^2

(a - b)^2 = a^2 - 2ab + b^2

@staticmethod
def directives_test():
    ...

This is a reference for Sphinx-style RST-style docstrings. Check source code to see how it works.

Code example

data = {
    'key': 'value',
}

print(data)

Type: str Return statement

@staticmethod
def reference():
    ...

Test for Version-related directives

Added in version 2.5 The spam parameter.

Changed in version 2.7 Mandatory spam parameter.

Deprecated in version 3.1 Use :func:spam instead.

@staticmethod
def version_directives_test():
    ...