主页

索引

模块索引

搜索页面

Domains

• 官网: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

Standard

dest_dir

Destination directory.

-m <module>, --module <module>

Run a module as a script.

JS

$.getJSON(href, callback[, errback])

参数:

• href (string()) – An URI to the location of the resource.

• callback – Gets called with the object.

• errback – Gets called in case the request fails. And a lot of other text so we need multiple lines.

抛出:

SomeError() – For whatever reason in that case.

返回:

Something.

reStructuredText

.. foo::

Foo description.

.. bar:: baz

Bar description.

.. toctree::

:maxdepth: (integer or no value)

:foo:

Foo description.

Math

(1)\[e^{i\pi} + 1 = 0\]

Euler’s identity, equation (1), was elected one of the most beautiful mathematical formulas.

Python

Timer.repeat(repeat=3, number=1000000)

class Foo

quux()

– or –

class Bar

Bar.quux()

主页

索引

模块索引

搜索页面