pdoc API documentation
All packages pdoc module Module pdoc provides types and functions for accessing the public documentation of a Python module. This includes modules (and sub-modules), functions, classes and module, class and instance variables. Docstrings are taken from modules, functions and classes using the special __doc__ attribute. Docstrings for variables are extracted by examining the module's abstract synta
A better changelog - bitprophet.org
Changelogs are a frequently overlooked aspect of software release management. I’m going to outline the different approaches to keeping them, and describe a dumb yak shave I undertook to improve the situation for my own projects. Changelog approaches No changelog A disturbing number of projects don’t keep any changelog. Those responsible are awful people who clearly don’t want anybody using their s
プレーンテキストからビジュアルな文書を生成できるreStructuredTextとrst2a | OSDN Magazine
reStructuredText は、文書を読みやすくしてくれるライトウェイトなマークアップ言語だ。見た目に美しいHTML、PDF、XML、さらにはS5の各ドキュメントを、プレーンテキストファイルから生成することができる。 reStructuredTextは、プレーンテキストをより好ましいフォーマットの文書に変換するためのオープンソースのテキスト処理システム、 Docutils の一部である。DocutilsはPythonで書かれており、大半のLinuxディストリビューションにはパッケージが用意されている。LinuxおよびMicrosoft Windows環境ではソースからのインストールも可能だ。 reStructuredTextは、PythonのDocStringをはじめとする、ドキュメンテーションの領域で使われるマークアップ構文として登場した。目指したのはシンプルでわかりやすく、それで
SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト - 傀儡師の館.Python：楽天ブログ
2008.03.23 SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト (317) テーマ：プログラミング言語 Python を使う(336) カテゴリ：Python SPHINX: PYTHON DOCUMENTATION GENERATOR を見る。SPHINX は、Georg Brandl 氏によって作られた Python プロジェクトのドキュメントを生成してくれるプログラム。reStructuredText のソースを HTML、Windows HTML Help、LaTeX、PDF といった出力形式で出力してくれる。reStructuredText のパースは、Docutils を使っているようだ。元は、Python Documentation のために作られて、他でも使えるように、きれいに書き直されたもののようだ。 対象となるのは、基本的に
Pyxis のドキュメント生成 - Pyxis 開発ブログ
Pyxis のドキュメント生成では、EpyDoc と Sphinx を使っています。Pylons 0.9.6.1 のデフォルトでは Pudge を用いた仕組みが提供されているのですが、Pudge のメンテナンスが遅れている（古いバージョンのKidなどに依存している）ため、うまく動きません。 Sphinx は Python 2.6 における公式のドキュメンテーションツールで、Pylons でも最近 Pudge から Sphinx への乗り換えを行ったようです。 なぜ2つのドキュメンテーションツールを使っているかというと、EpyDoc がAPI リファレンスの自動生成用、Sphinx がマニュアル作成用だからです。ともに、reStructuredText で書いています。 Sphinx のインストール easy_install でインストールできます。コードハイライトのための Pygments
Overview — Sphinx v1.0.7 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ページを開く
DropCatch.com