鈴木たかのり (@takanory) です。今月の 「Python Monthly Topics」 では、Python製の静的サイトジェネレーターSphinxを使用してWebサイトを構築し、テーマを適用、外部へ公開する流れについて紹介します。後半ではSphinxの便利な拡張機能を紹介し、Webサイトをより ...
SphinxはPythonの公式ドキュメントやサードパーティライブラリ、またほかの言語や書籍にも利用されるドキュメンテーションツールです。HTMLやPDFでドキュメントを生成できます。 公式サイト: Overview — Sphinx 4.0.0+ documentation 日本語版の公式サイト: 概要 — Sphinx ...
※本記事は、別ブログで2018年に書いた記事のリメイク版です。掲載している諸々のバージョンが古い可能性があります。 APIドキュメント作るときの悩み みんなお仕事で、ライブラリとかのAPIドキュメント作るのってどうしてんだろう。WordとかExcelで作った ...
Sphinx を使ってコードから綺麗な HTML ドキュメントを作るための最短実践ガイド 目的は「Python のソースに書いた docstring をそのまま HTML にして公開できる」こと。手を動かしながら学べるように、設定・書き方・コマンド・よくある落とし穴をまとめます。
hrsano645added the documentation Improvements or additions to documentation label Aug 10, 2020 ...