)
Sphinx (ドキュメンテーションジェネレータ) - Wikipedia
Sphinxは、Pythonで書かれているドキュメンテーションジェネレータである。 主にPythonコミュニティで利用されているが、その他の環境でも利用されている。 目的と機能[編集] SphinxはreStructuredTextをHTML (ウェブサイト) やPDF、EPUB、Texinfo及びmanページなどの他のフォーマットに変換する。 reStructuredTextには拡張性があり、Sphinxはソースコードからのドキュメントの自動生成、数式の表現、ソースコードのシンタックスハイライトなどにこれを利用している。 歴史と用例[編集] 最初の公開リリースであるバージョン 0.1.61611は2008年3月21日に発表された[2]。 SphinxはPythonプロジェクトのドキュメントのために開発され、広く利用されている[3]。 Sphinxは2008年に公開されて以来、Bazaar
sphinx でドキュメント作成からWeb公開までをやってみた - Qiita
はじめに 今回、ドキュメントをソースコードと同じ場所にまとめておきたいと思い、sphinx を使ってドキュメント作成を行なったので、その内容をまとめておきます。 sphinx とは？ sphinx とは Python 製のドキュメント生成ツールです。 reST(reStructuredText) 記法でドキュメントを作成できるので、マークダウンに慣れている人には非常に使いやすいと思います。 Python の公式ドキュメントも sphinx で作成されているそうです。 インストール pip install で sphinx を install します。 プロジェクト作成 コマンドでプロジェクトを作成します。 人が作った、sphinx のプロジェクトを見ると、いろんなディレクトリがあって、ややこしそうだなーと思っていたのですが、 コマンド一つで自動作成されていたことを、この時初めて知りました。
Overview — Sphinx documentation
Sphinx makes it easy to create intelligent and beautiful documentation. Here are some of Sphinx’s major features: Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information Hierarchic
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
