Skip to content

Generate API documentation #28

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

Merged
merged 2 commits into from
Oct 9, 2024
Merged

Generate API documentation #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2a2070
api doc generating
cadenmyers13 Oct 8, 2024
165a9b1
api news
cadenmyers13 Oct 8, 2024
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
31 changes: 0 additions & 31 deletions doc/source/api/diffpy.fourigui.example_package.rst
View file
Open in desktop

This file was deleted.

20 changes: 5 additions & 15 deletions doc/source/api/diffpy.fourigui.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,20 @@
:tocdepth: -1

|title|
=======

.. |title| replace:: diffpy.fourigui package
diffpy.fourigui package
=======================

.. automodule:: diffpy.fourigui
:members:
:undoc-members:
:show-inheritance:

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

.. toctree::
diffpy.fourigui.example_package

Submodules
----------

|module|
--------

.. |module| replace:: diffpy.fourigui.example_submodule module
diffpy.fourigui.fourigui module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.fourigui.example_submodule
.. automodule:: diffpy.fourigui.fourigui
:members:
:undoc-members:
:show-inheritance:
23 changes: 23 additions & 0 deletions news/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Added api documentation

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>