構成変更提案
#16
Replies: 1 comment
-
賛同の有無関係なく、実施許諾条件に反している(可能性が高い)ので、撤回(削除)します。 |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
私は、本チュートリアルの利用者にGithubの知識は求めません。
Githubからサンプル入力ファイルをダウンロードする手順を説明した方が良いと思います。
一方、利用者の多くにとって、Sphinxによるドキュメント整形は必要ないと思います。
README.mdは必要な情報を提供するために利用したいので、このような構成を提案します。
https://github.com/matelier/phase0_tutorial_wsl
特徴は、サンプルとドキュメントを別ブランチに分離したことです。
mainブランチからドキュメントを追い出したので、ZIPダウンロードすると、ほぼサンプルだけが入手できます。
その手順をREADME.mdに書きました(本番利用する場合は、丁寧に書き直した方が良い)。
Reat the Docsは、docブランチからHTMLを生成します。関心のない利用者の目につき難くなりました。
https://phase0-tutorial-wsl-docdoc.readthedocs.io/ja/latest/削除済みBeta Was this translation helpful? Give feedback.
All reactions