#!/usr/bin/env python
# -*- coding: utf-8 -*-
import docfly
# Uncomment this if you follow Sanhe's Sphinx Doc Style Guide
#--- Manually Made Doc ---
doc = docfly.DocTree("source")
doc.fly(table_of_content_header="Table of Content")
#--- Api Reference Doc ---
package_name = "dataIO"
doc = docfly.ApiReferenceDoc(package_name,
dst="source",
ignore=[
"%s.packages" % package_name,
"%s.zzz_manual_install.py" % package_name,
])
doc.fly()
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
1. Creates auto-generate doc for each module / class / method / variable.
2. Creates Table of Content for sub chapter if you follow this
`Style Guide <http://www.wbh-doc.com.s3.amazonaws.com/docfly/02-sphinx-doc-style-guide/index.html>`_
"""
import docfly
from pathlib_mate import Path
import loc as package
source_dir = Path(__file__).absolute().parent.append_parts("source").abspath
# --- Manually Made Doc ---
# Comment this if you don't follow this style guide.
# http://www.wbh-doc.com.s3.amazonaws.com/docfly/02-sphinx-doc-style-guide/index.html
doc = docfly.DocTree(source_dir)
doc.fly(table_of_content_header="Table of Content")
# --- Api Reference Doc ---
package_name = package.__name__
doc = docfly.ApiReferenceDoc(package_name,
dst=source_dir,
ignored_package=[
"%s.pkg" % package_name,
"%s.zzz_ezinstall.py" % package_name,
])
doc.fly()
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import docfly
from pathlib_mate import Path
# Uncomment this if you follow Sanhe's Sphinx Doc Style Guide
#--- Manually Made Doc ---
doc = docfly.DocTree(
Path(Path(__file__).absolute().parent.parent, "source").abspath)
doc.fly(table_of_content_header="Table of Content (目录)")
#--- Api Reference Doc ---
package_name = "pyinit"
doc = docfly.ApiReferenceDoc(package_name,
dst=Path(
Path(__file__).absolute().parent.parent,
"source").abspath,
ignored_package=[
"%s.pkg" % package_name,
"%s.packages" % package_name,
"%s.zzz_manual_install.py" % package_name,
])
doc.fly()
