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

added notebooks and modified docs to render them #10

Merged
merged 1 commit into from
May 20, 2023

Conversation

eacharles
Copy link
Collaborator

Just a draft for now

@eacharles eacharles requested a review from OliviaLynn May 16, 2023 15:27
@eacharles
Copy link
Collaborator Author

This includes:

  1. Almost all of the notebooks in the rail ecosystem
  2. a script render_nb.py to build the notebooks
  3. Mods to the docs to build the notebooks if you do make html from the docs subdirectory

This is just to demonstrate that we can get these things working. I'm happy if folks want to tweak the details.

Copy link
Member

@OliviaLynn OliviaLynn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!

I'm not terribly familiar with the use of mock modules in the conf.py (though I know we've used some in rail for a long time now) - is this included to keep from overly bloating the build on RTD?

Also, now that we're building the notebooks through RTD, will mocking some of these impact the results of the notebooks?

@eacharles
Copy link
Collaborator Author

eacharles commented May 19, 2023 via email

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

Successfully merging this pull request may close these issues.

2 participants