{
    "content": [
        {
            "type": "text",
            "text": "# sphinx-autogen (man)\n\n## NAME\n\nsphinx-autogen - Generate autodoc stub pages\n\n## SYNOPSIS\n\nsphinx-autogen [options] <sourcefile> ...\n\n## DESCRIPTION\n\nsphinx-autogen  is  a tool for automatic generation of Sphinx sources that, using the autodoc\nextension, document items included in autosummary listing(s).\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (4 subsections)\n- **EXAMPLE**\n- **SEE ALSO**\n- **COPYRIGHT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "sphinx-autogen",
        "section": "",
        "mode": "man",
        "summary": "sphinx-autogen - Generate autodoc stub pages",
        "synopsis": "sphinx-autogen [options] <sourcefile> ...",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "-o",
                "long": null,
                "arg": "<outputdir>",
                "description": "Directory to place the output file. If it does not exist, it is created. Defaults to the value passed to the :toctree: option."
            },
            {
                "flag": "-s",
                "long": "--suffix",
                "arg": "<suffix>",
                "description": "Default suffix to use for generated files. Defaults to rst."
            },
            {
                "flag": "-t",
                "long": "--templates",
                "arg": "<templates>",
                "description": "Custom template directory. Defaults to None."
            },
            {
                "flag": "-i",
                "long": "--imported-members",
                "arg": null,
                "description": "Document imported members."
            }
        ],
        "examples": [
            "Given the following directory structure:",
            "docs",
            "├── index.rst",
            "└── ...",
            "foobar",
            "├── foo",
            "│   └── init.py",
            "└── bar",
            "├── init.py",
            "└── baz",
            "└── init.py",
            "and assuming docs/index.rst contained the following:",
            "Modules",
            "=======",
            ".. autosummary::",
            ":toctree: modules",
            "foobar.foo",
            "foobar.bar",
            "foobar.bar.baz",
            "If you run the following:",
            "$ PYTHONPATH=. sphinx-autogen docs/index.rst",
            "then the following stub files will be created in docs:",
            "docs",
            "├── index.rst",
            "└── modules",
            "├── foobar.bar.rst",
            "├── foobar.bar.baz.rst",
            "└── foobar.foo.rst",
            "and each of those files will contain a autodoc directive and some other information."
        ],
        "see_also": [
            {
                "name": "sphinx-build",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/sphinx-build/1/json"
            },
            {
                "name": "sphinx-apidoc",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/sphinx-apidoc/1/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-o <outputdir>",
                        "lines": 3,
                        "flag": "-o",
                        "arg": "<outputdir>"
                    },
                    {
                        "name": "-s <suffix>, --suffix <suffix>",
                        "lines": 2,
                        "flag": "-s",
                        "long": "--suffix",
                        "arg": "<suffix>"
                    },
                    {
                        "name": "-t <templates>, --templates <templates>",
                        "lines": 2,
                        "flag": "-t",
                        "long": "--templates",
                        "arg": "<templates>"
                    },
                    {
                        "name": "-i, --imported-members",
                        "lines": 2,
                        "flag": "-i",
                        "long": "--imported-members"
                    }
                ]
            },
            {
                "name": "EXAMPLE",
                "lines": 40,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 6,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "sphinx-autogen - Generate autodoc stub pages\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "sphinx-autogen [options] <sourcefile> ...\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "sphinx-autogen  is  a tool for automatic generation of Sphinx sources that, using the autodoc\nextension, document items included in autosummary listing(s).\n\nsourcefile is the path to one or more reStructuredText documents containing  autosummary  en‐\ntries with the :toctree:: option set. sourcefile can be an fnmatch-style pattern.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "",
                "subsections": [
                    {
                        "name": "-o <outputdir>",
                        "content": "Directory  to place the output file. If it does not exist, it is created.  Defaults to\nthe value passed to the :toctree: option.\n",
                        "flag": "-o",
                        "arg": "<outputdir>"
                    },
                    {
                        "name": "-s <suffix>, --suffix <suffix>",
                        "content": "Default suffix to use for generated files. Defaults to rst.\n",
                        "flag": "-s",
                        "long": "--suffix",
                        "arg": "<suffix>"
                    },
                    {
                        "name": "-t <templates>, --templates <templates>",
                        "content": "Custom template directory. Defaults to None.\n",
                        "flag": "-t",
                        "long": "--templates",
                        "arg": "<templates>"
                    },
                    {
                        "name": "-i, --imported-members",
                        "content": "Document imported members.\n",
                        "flag": "-i",
                        "long": "--imported-members"
                    }
                ]
            },
            "EXAMPLE": {
                "content": "Given the following directory structure:\n\ndocs\n├── index.rst\n└── ...\nfoobar\n├── foo\n│   └── init.py\n└── bar\n├── init.py\n└── baz\n└── init.py\n\nand assuming docs/index.rst contained the following:\n\nModules\n=======\n\n.. autosummary::\n:toctree: modules\n\nfoobar.foo\nfoobar.bar\nfoobar.bar.baz\n\nIf you run the following:\n\n$ PYTHONPATH=. sphinx-autogen docs/index.rst\n\nthen the following stub files will be created in docs:\n\ndocs\n├── index.rst\n└── modules\n├── foobar.bar.rst\n├── foobar.bar.baz.rst\n└── foobar.foo.rst\n\nand each of those files will contain a autodoc directive and some other information.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "sphinx-build(1), sphinx-apidoc(1)\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "2007-2021, Georg Brandl and the Sphinx team\n\n\n\n\n4.3.2                                       Dec 19, 2021                           SPHINX-AUTOGEN(1)",
                "subsections": []
            }
        }
    }
}