lasp / developer-guide

Guidelines for software developers at LASP
MIT License
1 stars 4 forks source link

Add Sphinx configuration #3

Closed bourque closed 6 months ago

bourque commented 7 months ago

Sphinx provides an easy means to convert markdown files into nicely-rendered HTML. If we decide to produce HTML files and host them somewhere (#2), we will need to add appropriate Sphinx config files / directory structure.

It would also be good to add a GitHub action that will automatically build the Sphinx docs upon a new pull request. An example of this can be found in the IMAP repo.