Open pan3793 opened 3 months ago
Hello, Mr. Pan, I would like to know if anyone has worked on this issue? I am not very familiar with Kyuubi's documentation construction and Sphinx, so I may need to spend some time learning and researching this part. I plan to spend about an hour each day and report the progress once a week. Do you think this is appropriate? If it is suitable, you can arrange it for me. Thank you.
@PorterZhang2021 go head, please.
Ok,I will do it.If I have any new questions or come to the exhibition, I will talk to you on this issue. Thanks.
What's the level of this task?
MEDIUM
Code of Conduct
Search before creating
Mentor
Skill requirements
Background and Goals
Kyuubi uses Sphinx to build the docs, and
RST
andMarkdown
are mixed-used.RST is a much more powerful format but easy to mess up and hard to learn, while Markdown is more popular and easy to learn.
Currently, Kyuubi uses a legacy
markdown==3.4.1
for Sphinx markdown support, which lacks some advanced features, e.g. variable substitution, which is likely to be used for "version"While the recommended powerful markdown solution is
myst_parser
https://www.sphinx-doc.org/en/master/usage/markdown.html, we should investigate and migrate to this one.Implementation steps
myst_parser
Additional context
Introduction of 2024H1 Kyuubi Code Contribution Program