#!/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()
except Exception: print("no custom css found") # Add data for Jinja2 # try: # from portformer.docs import doc_data # except Exception: # doc_data = {} # jinja_contexts = { # "doc_data": {"doc_data": doc_data}, # } # Api Reference Doc package_name = portformer.__name__ docfly.ApiReferenceDoc( conf_file=__file__, package_name=package_name, ignored_package=[ "%s.pkg" % package_name, "%s.docs" % package_name, "%s.tests" % package_name, ], ).fly() def setup(app): app.add_stylesheet("css/custom-style.css") app.add_javascript("js/sorttable.js")
#!/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 uszipcode 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, ]) 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()
} # Api Reference Doc import docfly import picage package_name = troposphere_mate.__name__ ignored_package_list = list() for sub_module in picage.Package(package_name).sub_modules: if sub_module != "_version": ignored_package_list.append("{}.{}".format(package_name, sub_module)) docfly.ApiReferenceDoc( conf_file=__file__, package_name=package_name, ignored_package=[ "%s.pkg" % package_name, "%s.docs" % package_name, "%s.tests" % package_name, "%s.examples" % package_name, "%s.orch_example" % package_name, "%s.code_generator" % package_name, ] + ignored_package_list ).fly() def setup(app): app.add_stylesheet('css/custom-style.css') app.add_javascript('js/sorttable.js')
custom_style_file_content = f.read().decode("utf-8") rst_prolog = "\n" + custom_style_file_content + "\n" except: pass # Add data for Jinja2 try: from pgr.docs import doc_data except: doc_data = dict() jinja_contexts = { "doc_data": { "doc_data": doc_data, }, } # Api Reference Doc import docfly package_name = pgr.__name__ docfly.ApiReferenceDoc(conf_file=__file__, package_name=package_name, ignored_package=[ "%s.docs" % package_name, "%s.res" % package_name, "%s.code" % package_name, "%s._version" % package_name, "%s.tests" % package_name, ]).fly()