sphinxでpythonのクラスや関数のドキュメントを自動生成する – joppot概要 みなさんこんにちはcandleです。今回はpythonのSphinxを使ってクラスや関数の説明を自動生成します。 前提 Python3を使って説明しますが、おそらくpython2でも動くと思います。 テストファイルを用意する main.pyとdog.pyファイルを作成します。 touch main.py dog.py main.pyに以下を記述します。 from dog import Dog def main(): dog = Dog() dog.show_name() if __name__ == "__main__": main() dog.pyを開いて以下を記述します。 class Dog(object): def __init__(self, name="bob"): self.name = name def bark(): print("Bow Wow") def show
