Pythonソースから文書の作成（Sphinx）

Python

2022.07.03

目次

概要
Sphinxのインストール
DocStringでのコメント記述
文書の作成
作成した文書例

概要

Pythonソースから文書を作成します。
手順は以下のとおりです。

Sphinxのインストール
DogString形式でのコメント記述
文書の作成

Sphinxのインストール

conda環境では以下の2つのコマンドでインストールが可能です。

# sphinxのインストール
conda install sphinx
# テーマのインストール
conda install sphinx_rtd_theme

DocStringでのコメント記述

Googleサジェスト×PlantUMLでマインドマップの作成

Pythonを使用して、Googleサジェストの結果をPlantUML形式でマインドマップにしてみました。

PlantUMLを使ってPythonでマインドマップを作成する方法

UML図などの作成に有用なPlantUMLをPythonを利用して実行し、作成した図を画像として取得する方法について解説します。

GoogleのサジェストAPIとは？Pythonのrequestsを使って取得する方法

Googleの予測検索機能をHTTP GETで取得し、XML形式データから必要なデータを抽出するところまでのPythonコードを説明します。

のソースコードに記載しているようなコメント文を参照してみてください。
公式のサンプルは以下です。

Example Google Style Python Docstrings — napoleon 0.7 documentation

文書の作成

以下のようなフォルダ構成を想定します。

Src以下にプロジェクトのソースを配置
Srcと同じ階層に文書を生成する

┠Src
｜┠src_XX.py
｜┠src_YY.py
｜└src_ZZ.py
┠doc
｜┠[Sphinxで生成されるファイル]

以下のコマンドを実行します

sphinx-apidoc -F -H [ProjectName] -A [Author]  -o doc Src

-F：Fullで作成
-H：プロジェクト名
-A：著者名
-o：出力先のディレクトリ名
最後：文書の対象となるソースが格納されているディレクトリ

作成した文書例

Key2Mindmap documentation

この文書は過去の記事で作成したソースから作成しています。
https://ichigoichie-blog.com/python_mindmap/

コメント

タイトルとURLをコピーしました