Closed szepeviktor closed 1 year ago
@mvorisek Oh nooo!! There are a lot more Markdown links in .rst file.
I personally prefer inlined links as there are easier to maintain.
ref: https://www.odoo.com/documentation/16.0/contributing/documentation/rst_cheat_sheet.html#external-hyperlinks tested in https://www.tutorialspoint.com/online_restructure_editor.php
Also what is your opinion or rst vs. MD, what about converting everything from rst to MD?
This is the first rst file I send a PR to :)
Would you like me to convert all .rst files to .md?
Yes, PR is welcomed.
I did some research:
and the conversion from rst to md can be non-lossless, so I would like to see some discussion about different options considered.
I tried rst-to-myst
and pandoc
convertors. rst-to-myst
is by order of magnitude better, but still a lot of manual changes are needed...
I am closing this PR as the docs require much more care.
Fixed in:
and
a week of hard work, but MyST is the future, rst was syntax hell
I wish you good work.
Currently broken: https://agile-core.readthedocs.io/en/develop/ Preview: https://github.com/szepeviktor/atk4_core/blob/patch-1/docs/index.rst
Docs: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#links-to-external-web-pages