define_05_docs

Document Build and Deploy Automation for Python Projects.

class pywf_open_source.define_05_docs.PyWfDocs

Namespace class for document related automation.

build_doc(real_run: bool = True, verbose: bool = True)

Use sphinx doc to build documentation site locally. It set the necessary environment variables so that the make html command can build the HTML successfully.

Run:

sphinx-build -M html docs/source docs/build

view_doc(real_run: bool = True, verbose: bool = True)

View documentation site built locally in web browser.

It is usually at the ${dir_project_root}/build/html/index.html

Run:

# For MacOS / Linux
open build/html/index.html
# For Windows
start build/html/index.html

notebook_to_markdown(real_run: bool = True, verbose: bool = True)

Convert Jupyter notebooks to Markdown files so they can be more efficiently included in the AI knowledge base.