Version 6.x.x Source

Introduction


Automatically setup docs for a project

Call from command line:

bench setup-docs app path


Class setup_docs

Inherits from __builtin__.object

__init__ (self, app)

Generate source templates for models reference and module API and templates at templates/autodoc


build (self, docs_version)

Build templates for docs models and Python API


build_user_docs (self)

Build templates for user docs pages, if missing.


copy_assets (self)

Copy jquery, bootstrap and other assets to files


is_py_module (self, basepath, folders, files)

No docs


make_docs (self, target, local=False)

No docs


make_folder (self, path, template=None, context=None)

No docs


make_home_pages (self)

Make standard home pages for docs, developer docs, api and models from templates


setup_app_context (self)

No docs


sync_docs (self)

Sync docs from /docs folder to Web Page.

Called as bench --site [sitename] sync-docs [appname]


update_index_txt (self, path)

No docs


write_files (self)

render templates and write files to target folder


write_model_file (self, basepath, module, doctype)

No docs


write_modules (self, basepath, folders, files)

No docs