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

Deploy docs to Read the Docs #109

Open
layik opened this issue Jan 28, 2023 · 3 comments
Open

Deploy docs to Read the Docs #109

layik opened this issue Jan 28, 2023 · 3 comments

Comments

@layik
Copy link
Collaborator

layik commented Jan 28, 2023 •
edited by ots22

Most straightforward to do this when the repo is public.

Import the repository from https://readthedocs.org/dashboard/import/
@layik layik mentioned this issue Jan 28, 2023
Open
6 tasks
layik added a commit that referenced this issue Jan 28, 2023
@layik
main.yml add doc builder based on tests and notebook success for #109
0cc0e2b
@ots22
Copy link
Member

ots22 commented Jan 28, 2023

Proposal to host the docs on Read the Docs (to set up when we make the repo public) instead of GH pages - what do you think?

@layik
Copy link
Collaborator Author

layik commented Jan 28, 2023 •
edited

Sure. I assume we can automate deployment? I did a quick search but failed to see I think it happens on rtd site so feel free to close this and the PR!

@ots22
Copy link
Member

ots22 commented Jan 29, 2023

Yes it's possible. I'll repurpose this issue and close the PR.

@ots22 ots22 changed the title Add docs builder action & deploy to gh-pages Deploy docs to Read the Docs Jan 29, 2023
@ots22 ots22 mentioned this issue Jan 29, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@layik @ots22