search

OpenDataServices / sphinx-base

The base Sphinx setup (recommonmark + internationalisation) for Open Data Services docs projects. Builds at https://sphinx-base.readthedocs.io
Other
3 stars 4 forks source link

Use MyST instead of Recommonmark #6

Closed duncandewhurst closed 2 years ago

duncandewhurst commented 2 years ago

From https://github.com/readthedocs/recommonmark:

Warning: recommonmark is now deprecated. We recommend using MyST for a docutils bridge going forward. See this issue for background and discussion.

ScatteredInk commented 2 years ago

I think this was already implemented in https://github.com/OpenDataServices/sphinx-base/pull/5

But the readme was not updated and there is no changelog, so it is not possible to tell this without inspecting https://github.com/OpenDataServices/sphinx-base/blob/8e4924fa58e2c0224e44f7fda4ff62078700538d/docs/conf.py#L33

I have had a similar issue in the past using this template and being unsure about the extensions that were added in https://github.com/OpenDataServices/sphinx-base/issues/1

Therefore I think we just need to update the readme to say what this repo actually does, including being explicit about the inclusion of ODSC maintained extensions.

duncandewhurst commented 2 years ago

Sounds good. Thanks, @ScatteredInk!