OSS開発MkDocsドキュメントをGitHubに登録してRead the Docsで自動公開する
ドキュメントのホスティングサービスRead the DocsにはGitHubと連携する機能があり、作成したドキュメントをGitHubに登録しておくと、Read the Docsのサーバで自動でビルドしてインターネット上に公開することが出来...
OSS開発
OSS開発OSS開発PythonのDocstringsからHTMLドキュメントを作る
PythonモジュールのAPIのドキュメントは、PythonソースコードにDocstringというお作法に則ってコメントに埋め込んでおくと、Sphinxを使ってPythonコードからドキュメントを抽出してHTMLなどに自動整形出来る。 ...
OSS開発MkDocsでRead the Docs用ドキュメントを作る
Markdown形式で書いた文書をHTMLへ自動レンダリングしてくれる静的サイトジェネレータMkDocsを使ってみた。静的サイトジェネレータはMkDocsの他ではSphinxが人気。ただSphinxのデフォルトであるreStructure...
OSS開発GitHubでリポジトリを作成して操作してみる
自作ソフトウエアをオープンソースとしてインターネット上に公開するためには、GitHubは必須ツールだろう。GitHubは公式サイトを始めとして様々なところで解説が行われているが、やれる事が多岐に渡っていて機能がてんこ盛りのためドキュメント...