search

csdms / bmi-topography

Fetch and cache land elevation data from OpenTopography through an API, BMI, or CLI
https://bmi-topography.readthedocs.io
MIT License
10 stars 4 forks source link

Fix documentation build #61

Closed mdpiper closed 5 months ago

mdpiper commented 10 months ago

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 commented 10 months ago

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

mdpiper commented 10 months ago

Ah, that would be awesome!

mdpiper commented 7 months ago

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.

mdpiper commented 5 months ago

Fixedf with #68.