search

LSSTDESC / rail

Top level "umbrella" package for RAIL
MIT License
8 stars 4 forks source link

added notebooks and modified docs to render them #10

Closed eacharles closed 1 year ago

eacharles commented 1 year ago

Just a draft for now

eacharles commented 1 year ago

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.

eacharles commented 1 year ago

I’m not exactly sure about the role of mock in building docs, so I just kinda blindly try stuff.We could collect notes on using it somewhere.On May 19, 2023, at 8:50 AM, Olivia R. Lynn @.***> wrote: @OliviaLynn approved this pull request.

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?

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: @.***>