5. API documentation and generated content ¶

5.1. `test_py_module`¶

5.2. C++ API ¶

type MyType¶: Some type

const MyType Foo(const MyType bar)¶: Some function type thing

template<typename T, std::size_t N> class std::array¶: Some cpp class

float Sphinx::version¶: The description of Sphinx::version.

int version¶: The description of version.

typedef std::vector<int> List¶: The description of List type.

enum MyEnum¶

An unscoped enum.

enumerator A¶

enum class MyScopedEnum¶

A scoped enum.

enumerator B¶

protected enum struct MyScopedVisibilityEnum : std::underlying_type<MySpecificEnum>::type¶

A scoped enum with non-default visibility, and with a specified underlying type.

enumerator B¶

5.3. JavaScript API ¶

Link to ModTopLevel()

class module_a.submodule.ModTopLevel()¶

Link to mod_child_1()
Link to ModTopLevel.mod_child_1()

ModTopLevel.mod_child_1()¶

Link to mod_child_2()

ModTopLevel.mod_child_2()¶

Link to module_a.submodule.ModTopLevel.mod_child_1()

Link to ModTopLevel()

class module_b.submodule.ModNested()¶

ModNested.nested_child_1()¶

Link to nested_child_2()

ModNested.nested_child_2()¶

Link to nested_child_1()

5.4. Generated Index ¶

Part of the sphinx build process is to generate an index file: Index.

5.5. Optional parameter args ¶

At this point optional parameters cannot be generated from code. However, some projects will manually do it, like so:

This example comes from django-payments module docs.

class payments.dotpay.DotpayProvider(seller_id, pin[, channel=0[, lock=False], lang='pl'])¶

This backend implements payments using a popular Polish gateway, Dotpay.pl.

Due to API limitations there is no support for transferring purchased items.

Parameters:

seller_id – Seller ID assigned by Dotpay
pin – PIN assigned by Dotpay
channel – Default payment channel (consult reference guide)
lang – UI language
lock – Whether to disable channels other than the default selected above

5.6. Data ¶

Data_item_1¶
Data_item_2¶
Data_item_3¶: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce congue elit eu hendrerit mattis.

Some data link Data_item_1.