Skip to content

Add generated cx_Freeze API to Sphinx autodocs #294

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.

Sign up for GitHub

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

Open
robbmcleod wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add generated cx_Freeze API to Sphinx autodocs #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 86 additions & 0 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
cx\_Freeze API
==================

Submodules
----------

cx\_Freeze\.common module
-------------------------

.. automodule:: cx_Freeze.common
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.dist module
-----------------------

.. automodule:: cx_Freeze.dist
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.finder module
-------------------------

.. automodule:: cx_Freeze.finder
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.freezer module
--------------------------

.. automodule:: cx_Freeze.freezer
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.hooks module
------------------------

.. automodule:: cx_Freeze.hooks
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.macdist module
--------------------------

.. automodule:: cx_Freeze.macdist
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.main module
-----------------------

.. automodule:: cx_Freeze.main
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.setupwriter module
------------------------------

.. automodule:: cx_Freeze.setupwriter
:members:
:undoc-members:
:show-inheritance:

cx\_Freeze\.windist module
--------------------------

.. automodule:: cx_Freeze.windist
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: cx_Freeze
:members:
:undoc-members:
:show-inheritance:
13 changes: 12 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,18 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
'sphinx.ext.todo',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'numpydoc',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
2 changes: 2 additions & 0 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Contents:
releasenotes.rst
development/index.rst
license.rst
api.rst


Indices and tables
==================
Expand Down