Skip to content

Commit 932f39f

Browse files
angelayifacebook-github-bot
authored andcommitted
Update rst files for python docstring generation (#399)
Summary: Pull Request resolved: #399 backends/backend_api.py was previously moved to exir/backend/backend_api.py, so we need to update the docstring generation. Reviewed By: svekars Differential Revision: D49381377 fbshipit-source-id: 67733a12071d1f26c46149f52b5d4c39aa44eb82
1 parent 395e51a commit 932f39f

File tree

5 files changed

+114
-191
lines changed

5 files changed

+114
-191
lines changed

docs/source_py/backends.rst

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/source_py/exir.backend.rst

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
exir.backend
2+
============
3+
4+
exir.lowered_backend_module
5+
-------------------------------
6+
7+
.. autoclass:: exir.lowered_backend_module.LoweredBackendModule
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
exir.backend.backend\_api
13+
-----------------------------
14+
15+
.. automodule:: exir.backend.backend_api
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
exir.backend.backend\_details
21+
------------------------------------
22+
23+
.. automodule:: exir.backend.backend_details
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
exir.backend.compile\_spec\_schema
29+
-----------------------------------
30+
31+
.. autoclass:: exir.backend.compile_spec_schema.CompileSpec
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
exir.backend.partitioner
37+
---------------------------
38+
39+
.. autoclass:: exir.backend.partitioner.DelegationSpec
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
.. autoclass:: exir.backend.partitioner.PartitionResult
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
.. autoclass:: exir.backend.partitioner.Partitioner
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:

docs/source_py/exir.data_structures.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/source_py/exir.rst

Lines changed: 0 additions & 122 deletions
This file was deleted.

docs/source_py/index.rst

Lines changed: 62 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,66 @@
1-
Reference
1+
exir
2+
=======================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: exir
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
exir.emit
13+
---------------------------
14+
15+
.. automodule:: exir.emit
16+
17+
.. autofunction:: emit_program
18+
19+
exir.error
20+
----------------------------
21+
22+
.. automodule:: exir.error
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
27+
exir.memory
28+
-----------------------------
29+
30+
.. automodule:: exir.memory
31+
:members:
32+
:undoc-members:
33+
:show-inheritance:
34+
35+
exir.memory\_planning
36+
---------------------------------------
37+
38+
.. automodule:: exir.memory_planning
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
43+
exir.pass\_base
44+
-------------------------------------------
45+
46+
.. automodule:: exir.pass_base
47+
:members:
48+
:undoc-members:
49+
:show-inheritance:
50+
51+
exir.pass\_manager
52+
-------------------------------------------
53+
54+
.. automodule:: exir.pass_manager
55+
:members:
56+
:undoc-members:
57+
:show-inheritance:
58+
59+
Subpackages
260
-----------
361

462
.. toctree::
5-
:maxdepth: 1
6-
:caption: API
63+
:maxdepth: 4
764

8-
exir
9-
backends
65+
exir.backend
66+
exir.passes

0 commit comments

Comments
 (0)