Skip to content

Added scipy sphinx theme and first notebook. #1

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
wants to merge 1 commit into from

Conversation

melissawm
Copy link
Member

First attempt at getting the sphinx theme working. Added first notebook (SVD tutorial from the official docs).

@charris
Copy link
Member

charris commented May 8, 2020

It looks like you put all the files in the repo root, they should probably be somewhere in doc/

@rgommers rgommers added the enhancement New feature or request label May 11, 2020
@rgommers
Copy link
Member

Question: is it a good idea to have the Sphinx theme in here? I'm not sure either way, it's just something I hadn't expected here. In my mind the workflow would be: review notebooks here with reviewnb, merge, deal with Sphinx integration over in the main repo.

Doing it here may be nicer, to be able to iterate without triggering the large battery of CI in the main repo. Would be good to lay out the workflow though - we want to avoid tightly coupling new notebook tutorial PRs to dealing with Sphinx-ifying.

@melissawm
Copy link
Member Author

I'm closing this PR as in discussions with the Docs Team we figured having MyST-NB might be a better approach, as it would be simpler for users to build the notebooks and contribute to the repo. I'll follow up with a new PR after I have this figured out.

@melissawm melissawm closed this Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants