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

Add methods to API auto-documentation #160

Closed
Tracked by #159
abkfenris opened this issue Mar 9, 2023 · 0 comments · Fixed by #167
Closed
Tracked by #159

Add methods to API auto-documentation #160

abkfenris opened this issue Mar 9, 2023 · 0 comments · Fixed by #167
Labels
documentation Improvements or additions to documentation

Comments

@abkfenris
Copy link
Member

abkfenris commented Mar 9, 2023 •
edited
Loading

Right now methods like Rest.register_plugin() don't get full documentation, and only the summary shows up (first line of the doc string). I noticed this when looking for the expanded docstring from the changes in #158 .

One method would be to explicitly add these methods to api.rst the same way Rest.serve() is. Then they will show with summary on both the Rest class page, and have their own subpage (Rest.serve).

https://github.com/xarray-contrib/xpublish/blob/8a2e5d3482e54b426b8371c23b333d96deae6541/docs/source/api.rst?plain=1#L13-L19
@abkfenris abkfenris mentioned this issue Mar 9, 2023
Open
9 tasks
@abkfenris abkfenris added documentation Improvements or additions to documentation good first issue Good for newcomers and removed good first issue Good for newcomers labels Mar 9, 2023
@abkfenris abkfenris mentioned this issue Mar 9, 2023
Merged
abkfenris added a commit to abkfenris/xpublish that referenced this issue Mar 11, 2023
@abkfenris
Add methods to API docs and use typehints
47626f4 
Closes xpublish-community#160 xpublish-community#161
@abkfenris abkfenris mentioned this issue Mar 11, 2023
Merged
abkfenris added a commit that referenced this issue Mar 21, 2023
@abkfenris
Add methods to API docs and use typehints (#167)
f2171bb 
* Add methods to API docs and use typehints

Closes #160 #161

* Add make live command for using with sphinx-autobuild

* Remove duplicate typing from register_plugin
abkfenris added a commit to abkfenris/xpublish that referenced this issue Apr 4, 2023
@abkfenris
Add methods to API docs and use typehints
c6cb802 
Closes xpublish-community#160 xpublish-community#161
abkfenris added a commit that referenced this issue May 11, 2023
@abkfenris
Docs revamp (#180)
18ec94a 
* Add methods to API docs and use typehints

Closes #160 #161

* Use the Pydata theme for docs

Closes #164

* Add methods to API docs and use typehints

Closes #160 #161

* Use the Pydata theme for docs

Closes #164

* Hide the top menu navigation from the index page

* Docs revamp

Start of a big revamp of the docs.
- Uses Pydata theme
- Enables MyST markdown and converts a lot of the docs to it (rst heading levels and git conflict formatting conflict, which was a fun discovery)
- Re-arranges things along the Diátaxis framework lines, or at least how they are being used in the PyData space
- Adds the vision or 'Why Xpublish' page
- Breaks the tutorial into sections and scaffolds sections for use of plugins

Closes #163 #165 #162 #166

* Update xarray-contrib to xpublish-community

* Pre-commit format markdown and docs code snippets

* Dataset router plugin tutorial and other doc tweaks

* Use literalinclude rather than duplicating doc code

* Remove some under-construction alerts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add methods to API docs and use typehints abkfenris/xpublish
1 participant
@abkfenris