Skip to content

Update rst files for python docstring generation #399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 0 additions & 46 deletions docs/source_py/backends.rst

This file was deleted.

52 changes: 52 additions & 0 deletions docs/source_py/exir.backend.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
exir.backend
============

exir.lowered_backend_module
-------------------------------

.. autoclass:: exir.lowered_backend_module.LoweredBackendModule
:members:
:undoc-members:
:show-inheritance:

exir.backend.backend\_api
-----------------------------

.. automodule:: exir.backend.backend_api
:members:
:undoc-members:
:show-inheritance:

exir.backend.backend\_details
------------------------------------

.. automodule:: exir.backend.backend_details
:members:
:undoc-members:
:show-inheritance:

exir.backend.compile\_spec\_schema
-----------------------------------

.. autoclass:: exir.backend.compile_spec_schema.CompileSpec
:members:
:undoc-members:
:show-inheritance:

exir.backend.partitioner
---------------------------

.. autoclass:: exir.backend.partitioner.DelegationSpec
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: exir.backend.partitioner.PartitionResult
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: exir.backend.partitioner.Partitioner
:members:
:undoc-members:
:show-inheritance:
18 changes: 0 additions & 18 deletions docs/source_py/exir.data_structures.rst

This file was deleted.

122 changes: 0 additions & 122 deletions docs/source_py/exir.rst

This file was deleted.

67 changes: 62 additions & 5 deletions docs/source_py/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,66 @@
Reference
exir
=======================

Module contents
---------------

.. automodule:: exir
:members:
:undoc-members:
:show-inheritance:

exir.emit
---------------------------

.. automodule:: exir.emit

.. autofunction:: emit_program

exir.error
----------------------------

.. automodule:: exir.error
:members:
:undoc-members:
:show-inheritance:

exir.memory
-----------------------------

.. automodule:: exir.memory
:members:
:undoc-members:
:show-inheritance:

exir.memory\_planning
---------------------------------------

.. automodule:: exir.memory_planning
:members:
:undoc-members:
:show-inheritance:

exir.pass\_base
-------------------------------------------

.. automodule:: exir.pass_base
:members:
:undoc-members:
:show-inheritance:

exir.pass\_manager
-------------------------------------------

.. automodule:: exir.pass_manager
:members:
:undoc-members:
:show-inheritance:

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

.. toctree::
:maxdepth: 1
:caption: API
:maxdepth: 4

exir
backends
exir.backend
exir.passes