Skip to content

Upgrade doc generator to JupyterBook 2 #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 12 commits into
base: master
Choose a base branch
from
Draft

Upgrade doc generator to JupyterBook 2 #63

wants to merge 12 commits into from

Conversation

@kvrigor
Copy link
Member

@kvrigor kvrigor commented Apr 30, 2025 •
edited
Loading

This PR upgrades the eCLM doc generator to JupyerBook 2. This version vastly improves on the MyST markdown which allows for a richer tooling for doc authoring and UI rendering. From Towards Jupyter Book 2 with MyST-MD:

With MyST-MD, the project added a critical new capability: a document structure and engine in addition to the MyST markdown syntax. Rather than parsing MyST to Sphinx, MyST-MD provides its own standard document format and structure (as JSON), and an engine that exposes MyST documents in a flexible and reusable way. As such, MyST-MD is able to replace Sphinx in a growing number of scenarios; with the mystmd command line interface (CLI), it is now possible to use MyST-MD to produce scientific PDFs, documents, and websites.

JupyterBook 2 is a drop-in upgrade and future-proofs the eCLM doc engine.

kvrigor added 2 commits April 30, 2025 15:06
@kvrigor
docs.yml updates
5fc2c26 
- Locked Ubuntu version to 24.04
- Upgraded to Python 3.12
- Created a separate 'deploy' job
@kvrigor
docs.yml: Fixed wrong job IDs
a8ef420
@jjokella jjokella mentioned this pull request May 6, 2025
Merged
@kvrigor kvrigor changed the title Documentation updates Upgrade doc generator to JupyterBook 2 May 6, 2025
@kvrigor
Copy link
Member Author

kvrigor commented May 6, 2025

Putting this on hold until jupyter-book/mystmd#1445 is resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AGonzalezNicolas AGonzalezNicolas AGonzalezNicolas approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kvrigor @AGonzalezNicolas