File: autodoc2.rst

package info (click to toggle)
python-sphinx-autodoc2 0.5.0-6
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 1,268 kB
  • sloc: python: 3,407; xml: 72; makefile: 9
file content (71 lines) | stat: -rw-r--r-- 1,105 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
:py:mod:`autodoc2`
==================

.. py:module:: autodoc2

.. autodoc2-docstring:: autodoc2
   :allowtitles:

Subpackages
-----------

.. toctree::
   :titlesonly:
   :maxdepth: 3

   autodoc2.render
   autodoc2.sphinx

Submodules
----------

.. toctree::
   :titlesonly:
   :maxdepth: 1

   autodoc2.db
   autodoc2.config
   autodoc2.analysis
   autodoc2.cli
   autodoc2.utils
   autodoc2.resolve_all
   autodoc2.astroid_utils

Package Contents
----------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`setup <autodoc2.setup>`
     - .. autodoc2-docstring:: autodoc2.setup
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`__version__ <autodoc2.__version__>`
     - .. autodoc2-docstring:: autodoc2.__version__
          :summary:

API
~~~

.. py:data:: __version__
   :canonical: autodoc2.__version__
   :value: '0.4.2'

   .. autodoc2-docstring:: autodoc2.__version__

.. py:function:: setup(app)
   :canonical: autodoc2.setup

   .. autodoc2-docstring:: autodoc2.setup