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