Skip to content

MkDocs#30

Merged
unbohn merged 2 commits intoisofit:mainfrom
jammont:docs/mkdocs
Jan 22, 2026
Merged

MkDocs#30
unbohn merged 2 commits intoisofit:mainfrom
jammont:docs/mkdocs

Conversation

@jammont
Copy link
Collaborator

@jammont jammont commented Jan 14, 2026

Uses mkdocs to build the docs website on each push to main via a github workflow. I've updated the NEON notebooks as well as one of @evan-greenbrg's notebooks to be working with modern ISOFIT. These notebooks have their output cells stripped, and mkdocs will execute them in order to generate the notebooks properly. This keeps the file sizes small as well as allows us to use them as another test set of ISOFIT.

Building the docs works locally via mkdocs serve. Testing of the autodeployment of the website may need some iterations and pushes to main.

@jammont jammont added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 14, 2026
@evan-greenbrg
Copy link
Contributor

This is great! I'll remake #24 to base off of this instead of sphinx. I'm trying to get this up and running locally. Out of the box it hasn't worked for me yet after installing mkdocs and the nbconvert plugin.

In #24 I have a couple of new .ipynb's . The goal of that PR (in addition to adding a static tutorial site) is the flesh out the static and notebook tutorials. there is some duplication between the NEON, multisurface and the updated notebooks I have in that. PR. Do you have any issue with me taking a stab in that PR to fold the NEON tutorial in with the others?

I'm thinking we could have a number of tutorials going from entry-level use to power-use:

  1. Download, set-up, and CLI functionality
  2. Apply OE and configs
  3. Direct function calls
  4. Applied functionalities (Glint, Multisurface, future snow)

All up for discussion.

@unbohn
Copy link
Collaborator

unbohn commented Jan 22, 2026

Thanks for this great update, @jammont! Merging.

@unbohn unbohn merged commit 6878901 into isofit:main Jan 22, 2026
@jammont jammont mentioned this pull request Jan 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants