diff --git a/demo_docs/source/api.rst b/demo_docs/source/api.rst new file mode 100644 index 00000000..06858e68 --- /dev/null +++ b/demo_docs/source/api.rst @@ -0,0 +1,7 @@ +:mod:`test_py_module` +===================== + +.. automodule:: test_py_module.test + :members: + :private-members: + :special-members: diff --git a/demo_docs/source/index.rst b/demo_docs/source/index.rst index a47a3b9f..4436c48f 100644 --- a/demo_docs/source/index.rst +++ b/demo_docs/source/index.rst @@ -24,6 +24,7 @@ Contents: :caption: This is an incredibly long caption for a long menu long + api Maaaaath! ========= @@ -57,14 +58,6 @@ Giant tables | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | +------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+ -API Test -======== - -.. automodule:: test_py_module.test - :members: - :private-members: - :special-members: - Optional parameter args ----------------------- diff --git a/demo_docs/source/test_py_module/test.py b/demo_docs/source/test_py_module/test.py index ca7a8bc9..317c3dbf 100644 --- a/demo_docs/source/test_py_module/test.py +++ b/demo_docs/source/test_py_module/test.py @@ -26,6 +26,10 @@ class Foo: print(myclass) + + Here is a link to :py:meth:`capitalize`. + Here is a link to :py:meth:`__init__`. + """ #: Doc comment for class attribute Foo.bar.