Skip to content

Add hosted API documentation #18

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.

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

Closed
Tracked by #67
dstansby opened this issue May 3, 2022 · 5 comments · Fixed by #83
Closed
Tracked by #67

Add hosted API documentation #18

dstansby opened this issue May 3, 2022 · 5 comments · Fixed by #83
Assignees
Labels
Docs Improvements or additions to documentation
Milestone

Comments

@dstansby
Copy link
Member

dstansby commented May 3, 2022

The documentation is currently set up in the docs directory, but isn't automatically built or published. This can't be done with readthedocs becuase it's not possible to install xvfb there. Instead the docs should be built on GitHub actions and published ot a GitHub pages repository.

@dstansby dstansby added the Docs Improvements or additions to documentation label May 3, 2022
@dstansby
Copy link
Member Author

dstansby commented Apr 19, 2023

I think it's now possible to use xvfb on readthedocs, so it would be best to use readthedocs instead of github actions.

@dstansby dstansby mentioned this issue Apr 19, 2023
5 tasks
@dstansby dstansby changed the title Add API documentation build/publish on GH actions Add hosted API documentation May 2, 2023
@dstansby dstansby self-assigned this May 3, 2023
@dstansby dstansby moved this from Todo to In Progress in napari-matplotlib plugin accelerator May 3, 2023
@dstansby
Copy link
Member Author

dstansby commented May 5, 2023

I'm having issues with readthedocs, specifically getting it to work without x-server erroring after the build. See #83 for my attempt.

I think it's better to pivot back to using GitHub pages for this, especially since that's what the official napari docs use, so we have an example to follow there and more likeley to have debugging buddies if we do run into any issues.

@samcunliffe
Copy link
Collaborator

My most recent example of doing this is in WAZP🐝.

@dstansby
Copy link
Member Author

dstansby commented May 5, 2023

Nice! Maybe a good topic for our in-person dev morning.

@dstansby dstansby moved this from In Progress to Todo in napari-matplotlib plugin accelerator May 5, 2023
@dstansby dstansby moved this from Todo to In Progress in napari-matplotlib plugin accelerator May 10, 2023
@dstansby
Copy link
Member Author

I've pivoted back - since the example gallery build doesn't work in GH action either, I figure it's best to disable the gallery build and just use readthedocs for now.

@dstansby dstansby added this to the 0.3.0 milestone May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants