Mkdocs Enhancements#857
Merged
Merged
Conversation
pgbrodrick
reviewed
Feb 10, 2026
Collaborator
|
Looking good - these changes all seem like solid improvements! Open minor question about dependencies. |
…ing for both click and mkapi
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Now that the docs are building and hosted properly, this PR further enhances the UX
Added
mikeaddon that will enable us to version control our docsChanged the theme from ReadTheDocs to Material
Added cookies consent, typical modern practice
Added social render links, which will make posting links to the docs look more professional
Fixed apply_oe docs
\bin the docstrings which were needed by Click to actually render the docstring reasonably in the terminal. I worked it around such that the custom Click class will insert these appropriately. This maintains nice terminal docs as well as proper website parsed docs.\bformatting, so right now it only applies to that. For other functions, follow the implementation seen at the bottom of apply_oe.py with__doc_source__Snuck in isofit no longer hiding CLI exceptions by default. Given I've been asked by multiple developers how to debug a CLI problem, I think it's best to just allow them to bubble instead. Isoplots ModuleNotFoundError are still hidden and only shown via the
--debugflag, but that's the only purpose of the flag nowNote: The
gh-pageswill need to be deleted before merging this so thatmikebuilds the docs in a different structure