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

generating Sphinx docs + Jupyter Book #100

Open
asemposki opened this issue Jun 19, 2024 · 0 comments
Open

generating Sphinx docs + Jupyter Book #100

asemposki opened this issue Jun 19, 2024 · 0 comments
Assignees

Comments

@asemposki
Copy link
Collaborator

Building both a Sphinx docs page and a Jupyter Book from the same GitHub repo is not allowed with GitHub Actions since one repo can only possess one domain. Jared looked at a few options for a workaround that won't be too cumbersome to implement and/or maintain, and one of the better ones is to build the Sphinx docs through Read The Docs, so that we can build the Jupyter Book from the repo. This seems to be relatively straightforward once you get through allowing Read the Docs all of the permissions it will need. Then the Book can be deployed using Actions, and we can point to the Book domain in our documentation for the interested user. The Book would then also not be on a separate, stripped branch, as it is now. I will start working on a branch that does this Jupyter Book building, and Jared will work on the Sphinx Docs through Read the Docs.

The toy repo that Jared set up to test these ideas is below, which we can implement here.
https://github.com/jared321/MyJBook/tree/main

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

2 participants