この記事はWindowsにてSphinxによるドキュメントを執筆する環境構築の手順を記載します。 Sphinxを利用するプロジェクトに新規メンバーが増えた際に説明が必要となったため書いた記事です。 基本的な文法などはユーザーグループサイトに記載がありますので、本記事では割愛します。 Sphinxとは reStructuredText形式で記述した文章をHTMLやePub、PDF(LaTeX経由)へ出力できる素敵なツールです。 Pythonのドキュメントを作成するために作られたツールのため、Pythonで動作します。 詳細は日本のSphinxユーザグループにより和訳されたオフィシャルページを確認しましょう。 http://www.sphinx-doc.org/ja/stable/index.html なにがいいの? 例えば、Wordと比較すると以下のようなメリットがあります。 文章を記述する
![Sphinx執筆環境をWindowsに構築する手順 - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/9143fdf378b1b682560d7f116a5b8acc5db4b851/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9U3BoaW54JUU1JTlGJUI3JUU3JUFEJTg2JUU3JTkyJUIwJUU1JUEyJTgzJUUzJTgyJTkyV2luZG93cyVFMyU4MSVBQiVFNiVBNyU4QiVFNyVBRiU4OSVFMyU4MSU5OSVFMyU4MiU4QiVFNiU4OSU4QiVFOSVBMCU4NiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTU2JnM9ODg3NzEwZTRmZmYxYTQ1NTU4ZjU5YzdlZjZiMjhjYTk%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDB0ZXJhaGlkZSZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTM2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9YWEwZGQ5NTdkYzNmNzk3ZDhjM2U5YzRkMmMxYmRhYmM%26blend-x%3D142%26blend-y%3D436%26blend-mode%3Dnormal%26txt64%3DaW4g5qCq5byP5Lya56S-5YaF55Sw5rSL6KGM%26txt-width%3D770%26txt-clip%3Dend%252Cellipsis%26txt-color%3D%2523212121%26txt-font%3DHiragino%2520Sans%2520W6%26txt-size%3D36%26txt-x%3D156%26txt-y%3D536%26s%3D3ee208fdf4b103ce12d64fa94f8715c7)