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

Jump to bottom

Make an autocontract directive #8

Open
antazoey opened this issue Sep 9, 2024 · 1 comment
Open

Make an autocontract directive #8

antazoey opened this issue Sep 9, 2024 · 1 comment
Labels
category: feature New feature or request

Comments

@antazoey
Copy link
Member

antazoey commented Sep 9, 2024

Overview

I want to be able to use auto-doc like directives for contracts so projects like ApePay can have docs for generated for the contracts.
Really, any Ape-project will be doc-able this way, and would make sense to make an ape-docs plugin at that point.

Specification

Exceptions


```{eval-rst}
.. autocontract:: contracts.SteamManager
    :members:



### Dependencies

Include links to any open issues that must be resolved before this feature can be implemented.
@antazoey antazoey added the category: feature New feature or request label Sep 9, 2024
@linear Linear
Copy link

linear bot commented Sep 9, 2024

APE-1809 Make an `autocontract` directive

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
category: feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@antazoey