Sphinx の sphinx_rtd_theme をカスタマイズする
Sphinx でドキュメントを作成する際、テーマを設定することができます。 デフォルトで用意されているテーマは一応全て試してみましたが、どれも気に入りませんでした。 なので、私はいつも Read the Docs のテーマ (sphinx_rtd_theme) を使用しています。 しかし、sphinx_rtd_theme にも気に入らない点がいくつかあります。 気に入らない点 見出しが分かりづらい 見出しのレベルによる違いが文字の大きさだけなので、どこが見出しの境目なのか分かりづらいと思います。 ちなみに Docker のドキュメントも sphinx_rtd_theme を使用していますが、こちらはカスタマイズされているようで、見出しにアンダーラインが引かれています。 これは分かりやすくなっていて良いと思います。 画面の横幅が固定されている レスポンシブ対応のためか、sphinx_rtd_
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - readthedocs/sphinx_rtd_theme: Sphinx theme from Read the Docs
