search

prithviulm / qudi-core

A framework for modular measurement applications.
https://qudi-core-testing.readthedocs.io/en/latest/
GNU General Public License v3.0
0 stars 2 forks source link

Convert all md to rst [Suggestion] #4

Closed prithviulm closed 3 months ago

prithviulm commented 9 months ago

Suggestion

Convert all documentation .md files to .rst.

Reasons

Sphinx does not natively support .md files so the MyST-Parser needs to be used. This is driving me insane. It probably could be done but literally everyone uses .rst so the documentation and examples are mostly for .rst. There are tools to automatically do the conversion. Note that the use of .ipynb should not be affected by this i.e. the jupyter notebooks (in the future) can still use markdown without issue.

Additional Context

No response

prithviulm commented 9 months ago

Yeah I caved and did this for some files already as an initial test. I wrote a small bash script to use pandoc to do the conversion. It probably isn't perfect, need to still check whether they render properly.

prithviulm commented 9 months ago

References to .md have been changed to .rst by 7ab1127bfaa96a36ab0f53fdb74e15975ba064f0. Next thing is to check the converted files and also fix any syntax issues and whatever else.

prithviulm commented 3 months ago

HiWi has worked on this. Syntax is problematic, need to check but can mark as done.