Skip to content
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.

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

Fix documentation build #61

Closed
mdpiper opened this issue Dec 18, 2023 · 4 comments
Closed

Fix documentation build #61

mdpiper opened this issue Dec 18, 2023 · 4 comments

Comments

@mdpiper
Copy link
Member

mdpiper commented Dec 18, 2023

Previously, I had been using pandoc to translate the Markdown files in the root directory of the repository into sphinx-friendly reStructuredText files for the documentation. In the move to nox for managing automated tasks, this got lost. It's now breaking. I need to evaluate if this workflow is still needed and fix it.

@mcflugen
Copy link
Member

mcflugen commented Dec 18, 2023

I think the myst-parser sphinx extension should do the trick. I've used it in a several projects, include bmi-wavewatch3.

@mdpiper
Copy link
Member Author

mdpiper commented Dec 18, 2023

Ah, that would be awesome!

@mdpiper
Copy link
Member Author

mdpiper commented Mar 22, 2024

Pretty sure this is caused by the md/rst formatting in the changelog when it's updated by zest.releaser. Converting to MyST for the docs should fix this. Or not letting zest.releaser touch the changelog.

This was referenced Mar 27, 2024
@mdpiper
Copy link
Member Author

mdpiper commented May 20, 2024

Fixedf with #68.

@mdpiper mdpiper closed this as completed May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants