Sphinx __main__和内部函数

Question

所以我想知道如何让Sphinx在我的__main__.py中自动生成一些文档，到目前为止我似乎无法使它工作。我有一些其他python文件可以自动生成一些东西。

在__main __。py

中

import os

def main():
    """
    Some helpful stuff about main
    """

    def function_1(stuff):
        """
        Some helpful stuff about function_1
        """
        pass

    def function_2(things):
        """
        Some helpful stuff about function_2
        """
        pass

    print(function_1())
    print(function_2())
    do_the_other_code_dot_jpg()

    return 0

if __name__ == '__main__':
    main()

在index.rst内部

Welcome to Some Test Docs
=========================

This is some test text.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   code


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

在code.rst内部

Report
======

.. automodule:: __main__
  :members:

当前目录结构树

Sphinx/
├── doc
│   ├── _build
│   │   ├── doctrees
│   │   │   ├── code.doctree
│   │   │   ├── environment.pickle
│   │   │   └── index.doctree
│   │   └── html
│   │       ├── code.html
│   │       ├── genindex.html
│   │       ├── index.html
│   │       ├── objects.inv
│   │       ├── py-modindex.html
│   │       ├── search.html
│   │       ├── searchindex.js
│   │       ├── _sources
│   │       │   ├── code.rst.txt
│   │       │   └── index.rst.txt
│   │       └── _static
│   │           ├── ajax-loader.gif
│   │           ├── alabaster.css
│   │           ├── basic.css
│   │           ├── comment-bright.png
│   │           ├── comment-close.png
│   │           ├── comment.png
│   │           ├── custom.css
│   │           ├── doctools.js
│   │           ├── down.png
│   │           ├── down-pressed.png
│   │           ├── file.png
│   │           ├── jquery-3.1.0.js
│   │           ├── jquery.js
│   │           ├── minus.png
│   │           ├── plus.png
│   │           ├── pygments.css
│   │           ├── searchtools.js
│   │           ├── underscore-1.3.1.js
│   │           ├── underscore.js
│   │           ├── up.png
│   │           ├── up-pressed.png
│   │           └── websupport.js
│   ├── code.rst
│   ├── conf.py
│   ├── index.rst
│   ├── Makefile
│   ├── _static
│   └── _templates
└── __main__.py

Here is an image of the index page

Here is an image of the __main__ module