api_reference_doc¶

Create api reference doc.

docfly.api_reference_doc.render_module(module)[source]¶

Return type: str

docfly.api_reference_doc.is_ignored(mod_or_pkg, ignored_package)[source]¶

Test, if this docfly.pkg.picage.Module or docfly.pkg.picage.Package should be included to generate API reference document.

Parameters

mod_or_pkg (typing.Union[Module, Package]) – module or package
ignored_package – ignored package

中文文档

根据全名判断一个包或者模块是否要被包含到自动生成的API文档中。

docfly.api_reference_doc.render_package(package, ignored_package)[source]¶

Parameters

package (list[str]) –
ignored_package –

Return type

str

class docfly.api_reference_doc.ApiReferenceDoc(conf_file, package_name, ignored_package=None)[source]¶

A class to generate sphinx-doc api reference part.

Example:

package
|--- subpackage1
    |--- __init__.rst
    |--- module.rst
|--- subpackage2
    |--- __init__.rst
    |--- module.rst
|--- __init__.rst
|--- module1.rst
|--- module2.rst

Parameters

conf_file (string) – the conf.py file for sphinx doc. it helps to locate the api reference doc destination directory
package_name (string) – the importable package name
ignore – default empty list, package, module relative prefix you want to ignored

中文文档

如果你需要忽略一个包: 请使用 docfly.packages 如果你需要忽略一个模块: 请使用 docfly.zzz_manual_install 或 docfly.zzz_manual_install.py

fly()[source]¶: Generate doc tree.

generate_package_content(package)[source]¶

Generate package.rst text content.

{{ package_name }}
==================

.. automodule:: {{ package_name }}
    :members:

sub packages and modules
------------------------

.. toctree::
   :maxdepth: 1

    {{ sub_package_name1 }} <{{ sub_package_name1 }}/__init__>
    {{ sub_package_name2 }} <{{ sub_package_name2 }}/__init__>
    {{ sub_module_name1}} <{{ sub_module_name1}}>
    {{ sub_module_name2}} <{{ sub_module_name2}}>

generate_module_content(module)[source]¶

Generate module.rst text content.

{{ module_name }}
=================

.. automodule:: {{ module_fullname }}
    :members: