Skip to content
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

docs: include auto-generated code docs #144

Merged
merged 2 commits into from
Dec 13, 2023
Merged

docs: include auto-generated code docs #144

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
e9c8892
docs: include auto-generated code docs
lengau Dec 12, 2023
b4b0b30
style: fix inline docs style
lengau Dec 12, 2023
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
2 changes: 1 addition & 1 deletion craft_store/base_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ def update_resource_revisions(

:param name: The package.
:param resource_name: The resource name to update.
:param *updates: The updates to make of any revisions
:param updates: The updates to make of any revisions
:returns: The number of revisions updated.

"""
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/auto-generated.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Automatically-generated Code Documentation
==========================================

.. automodule:: craft_store
:members:
3 changes: 3 additions & 0 deletions docs/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Reference
.. toctree::
:maxdepth: 1

Automatically-generated code documentation <auto-generated>


Indices and tables
==================

Expand Down