File: test_sphinx_build_directives.xml

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 (77 lines) | stat: -rw-r--r-- 4,312 bytes parent folder | download | duplicates (2)
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
72
73
74
75
76
77
<document source="index.rst" translation_progress="{'total': 0, 'translated': 0}">
    <section ids="test" names="test">
        <title>
            Test
        <literal_block highlight_args="{'linenostart': 9}" language="restructuredtext" linenos="True" xml:space="preserve">
            This is a function.
        <paragraph>
            This is a function.
        <literal_block language="restructuredtext" xml:space="preserve">
            .. py:function:: func(a: str, b: int) -> package.a.c.ac1
               :canonical: package.func

               .. autodoc2-docstring:: package.func
        <literal_block xml:space="preserve">
            ````{py:function} func(a: str, b: int) -> package.a.c.ac1
            :canonical: package.func

            ```{autodoc2-docstring} package.func
            ```
            ````
        <index entries="('single',\ 'func()\ (in\ module\ package)',\ 'package.func',\ '',\ None)">
        <desc classes="py function" desctype="function" domain="py" no-contents-entry="False" no-index="False" no-index-entry="False" no-typesetting="False" nocontentsentry="False" noindex="False" noindexentry="False" objtype="function">
            <desc_signature _toc_name="func()" _toc_parts="('package', 'func')" class="" classes="sig sig-object" fullname="func" ids="package.func" module="package">
                <desc_addname classes="sig-prename descclassname" xml:space="preserve">
                    package.
                <desc_name classes="sig-name descname" xml:space="preserve">
                    func
                <desc_parameterlist multi_line_parameter_list="False" multi_line_trailing_comma="True" xml:space="preserve">
                    <desc_parameter xml:space="preserve">
                        <desc_sig_name classes="n">
                            a
                        <desc_sig_punctuation classes="p">
                            :
                        <desc_sig_space classes="w">

                        <desc_sig_name classes="n">
                            <pending_xref py:class="True" py:module="package" refdomain="py" refspecific="False" reftarget="str" reftype="class">
                                str
                    <desc_parameter xml:space="preserve">
                        <desc_sig_name classes="n">
                            b
                        <desc_sig_punctuation classes="p">
                            :
                        <desc_sig_space classes="w">

                        <desc_sig_name classes="n">
                            <pending_xref py:class="True" py:module="package" refdomain="py" refspecific="False" reftarget="int" reftype="class">
                                int
                <desc_returns xml:space="preserve">
                    <pending_xref py:class="True" py:module="package" refdomain="py" refspecific="False" reftarget="package.a.c.ac1" reftype="class">
                        package.a.c.ac1
            <desc_content>
                <paragraph>
                    This is a function.
        <table align="left" classes="autosummary longtable">
            <tgroup cols="2">
                <colspec colwidth="50">
                <colspec colwidth="50">
                <tbody>
                    <row>
                        <entry>
                            <paragraph>
                                <pending_xref py:class="True" py:module="True" refdoc="index" refdomain="py" refexplicit="False" reftarget="package.func" reftype="obj" refwarn="False">
                                    <literal classes="xref py py-obj">
                                        package.func
                        <entry>
                            <paragraph>
                                This is a function.
                    <row>
                        <entry>
                            <paragraph>
                                <pending_xref py:class="True" py:module="True" refdoc="index" refdomain="py" refexplicit="True" reftarget="package.a.a1" reftype="obj" refwarn="False">
                                    <literal classes="xref py py-obj">
                                        package.a1
                        <entry>
                            <paragraph>
                                a1 can be documented here.