build_docs Namespace Reference

Functions
	build_docs (build, logger)
	build_sphinx_docs (docs_root, build_dir, tool_dir, build_type, logger)
	main ()
	remove_debug_files (build_dir, logger, doxygen_build_dir=None)
	set_up_logging (log_file_name)

Function Documentation

build_docs()

build_docs	(		build,
			logger )

 Builds selected documentation sets, including local or online. 

build_sphinx_docs()

build_sphinx_docs	(		docs_root,
			build_dir,
			tool_dir,
			build_type,
			logger )

Helper function to build Sphinx documentation.

main()

main

(

)

remove_debug_files()

remove_debug_files	(		build_dir,
			logger,
			doxygen_build_dir = None )

 Deletes the generated content that we don't want or need to publish. 

set_up_logging()

set_up_logging

(

log_file_name

)

 Configure logger.