Closed Hiroya-W closed 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に変換すると余計にわかりにくくなりそうです。
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に変換すると余計にわかりにくくなりそうです。
概要
reStructuredtextで書かれていたドキュメントをMarkdownに変換しました。 pyRef/modules.rstに関しては、#86 にも記述しましたが以下の理由で、そのままにしています。
pandocを使って変換し、スタイルが崩れている部分を手作業で修正しています。見落としている部分などあれば、指摘していただければ嬉しいです。