qulacs / qulacs-rtd

Qulacs documentation for readthedocs. Configured to support automatically generate C++/Python API, and internationalization.
MIT License
3 stars 3 forks source link

Convert reStructuredtext to Markdown #87

Closed Hiroya-W closed 1 year ago

Hiroya-W commented 1 year ago

概要

reStructuredtextで書かれていたドキュメントをMarkdownに変換しました。 pyRef/modules.rstに関しては、#86 にも記述しましたが以下の理由で、そのままにしています。

pandocを使って変換し、スタイルが崩れている部分を手作業で修正しています。見落としている部分などあれば、指摘していただければ嬉しいです。

Python APIを埋め込んでいるautodocに関しては、reStructuredtextの記法にしか対応しておらず、Markdownから触るにはラップする必要があるそう。 myst-parser.readthedocs.io/en/latest/faq/index.html#use-sphinx-ext-autodoc-in-markdown-files

pyRef/modules.rstが対応するのですが、このファイルに開発者が追記することはあまりなく、Markdownに変換すると余計にわかりにくくなりそうです。

Hiroya-W commented 1 year ago

85 をmergeしたらconflictしたので、masterブランチをrebaseしてforce pushしました