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.

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

Add GitHub action step for doc generation and deployment #34

Open
ghost opened this issue Nov 5, 2024 · 3 comments
Open

Add GitHub action step for doc generation and deployment #34

ghost opened this issue Nov 5, 2024 · 3 comments

Comments

@ghost
Copy link

ghost commented Nov 5, 2024

Upon a merge into master (after successful testing and review), we can trigger building the docs with sphinx and uploading to readthedocs.

Thoughts:

@rjplevin
Copy link
Collaborator

rjplevin commented Nov 5, 2024

It's not just changes in doc sources that matter: the API documentation is driven by the code & comments therein. I would just rebuild the docs each time.

@ghost
Copy link
Author

ghost commented Nov 13, 2024

Seems fine to me—no need to preemptively optimize 😃

@ghost
Copy link
Author

ghost commented Nov 13, 2024

I also found this resource on connecting github accounts and on manual integrations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant