2021-06-29 Thompson/Mitchell Check-in

Date

Jun 29, 2021

Participants

  • @Matt Thompson

  • @Josh Mitchell

Goals

  •  

Discussion topics

Item

Notes

Item

Notes

 

    • @Josh Mitchell will look through this sometime

    • Waiting on upstream fixes


Slow RTD build times?

Can probably experiment with trimming deps out of docs/environment.yml. Not doing this now, revisit later.

0.1.0 docs?

Josh generally prefers API docs, since it’s right by the source code.

  • Easier to maintain (changes a few lines apart), since it’s easy to forget to update .md/.rst files alongside changes tot he API, easy for them to drift apart

  • There’s a sphinx extension that gets Pydantic Field descriptions injected into the API docs

    • Probably this:

Action items

@Josh Mitchell will update PR #234 when the theme is finalized upstream
@Josh Mitchell will look through #235 sometime
@Matt Thompson will start a brief user guide

Decisions