documentationhelp wanted
Metriche repository
- Star
- (5 stelle)
- Metriche merge PR
- (Metriche PR in attesa)
Descrizione
Change Request:
- Convert all of the markdown (.md) files in docs/source/ to Sphinx standard restructured text (.rst) files.
- update docs/source/config.py to reflect the change
Reason:
I originally chose to use .md files in the sphinx documentation because we use .md for README and other in-repo documentation, and I had hoped having only one markdown format would simplify things and reduce the cognitive load on maintainers.
Unfortunately, writing .md files that work well with sphinx has proven difficult, with lots of little quirks. I think it will be better to change to sphinx's standard .rst format, which is better documented and supported.
Request for help:
Neither of our core developers are Sphinx experts, and I'm sure there is a lot that can be done to improve our documentation. Additional improvements beyond this change would be greatly appreciated.