def setUp(self):
self.log = logging.getLogger('dummy')
self.log.propagate = False
self.log.setLevel(1)
self.counter = utils.CountHandler()
self.log.addHandler(self.counter)
def build(config, live_server=False, dirty=False):
""" Perform a full site build. """
logger = logging.getLogger('mkdocs')
# Add CountHandler for strict mode
warning_counter = utils.CountHandler()
warning_counter.setLevel(logging.WARNING)
if config['strict']:
logging.getLogger('mkdocs').addHandler(warning_counter)
try:
from time import time
start = time()
# Run `config` plugin events.
config = config['plugins'].run_event('config', config)
# Run `pre_build` plugin events.
config['plugins'].run_event('pre_build', config=config)
if not dirty:
log.info("Cleaning site directory")
utils.clean_directory(config['site_dir'])
else: # pragma: no cover
# Warn user about problems that may occur with --dirty option
log.warning(
"A 'dirty' build is being performed, this will likely lead to inaccurate navigation and other"
" links within your site. This option is designed for site development purposes only."
)
if not live_server: # pragma: no cover
log.info(
f"Building documentation to directory: {config['site_dir']}")
if dirty and site_directory_contains_stale_files(
config['site_dir']):
log.info(
"The directory contains stale files. Use --clean to remove them."
)
# First gather all data from all files/pages to ensure all data is consistent across all pages.
files = get_files(config)
env = config['theme'].get_env()
files.add_files_from_theme(env, config)
# Run `files` plugin events.
files = config['plugins'].run_event('files', files, config=config)
nav = get_navigation(files, config)
# Run `nav` plugin events.
nav = config['plugins'].run_event('nav',
nav,
config=config,
files=files)
log.debug("Reading markdown pages.")
for file in files.documentation_pages():
log.debug(f"Reading: {file.src_path}")
_populate_page(file.page, config, files, dirty)
# Run `env` plugin events.
env = config['plugins'].run_event('env',
env,
config=config,
files=files)
# Start writing files to site_dir now that all data is gathered. Note that order matters. Files
# with lower precedence get written first so that files with higher precedence can overwrite them.
log.debug("Copying static assets.")
files.copy_static_files(dirty=dirty)
for template in config['theme'].static_templates:
_build_theme_template(template, env, files, config, nav)
for template in config['extra_templates']:
_build_extra_template(template, files, config, nav)
log.debug("Building markdown pages.")
doc_files = files.documentation_pages()
for file in doc_files:
_build_page(file.page, config, doc_files, nav, env, dirty)
# Run `post_build` plugin events.
config['plugins'].run_event('post_build', config=config)
counts = warning_counter.get_counts()
if counts:
msg = ', '.join([f'{v} {k.lower()}s' for k, v in counts])
raise Abort(f'\nAborted with {msg} in strict mode!')
log.info('Documentation built in %.2f seconds', time() - start)
except Exception as e:
# Run `build_error` plugin events.
config['plugins'].run_event('build_error', error=e)
if isinstance(e, BuildError):
log.error(str(e))
raise Abort('\nAborted with a BuildError!')
raise
finally:
logger.removeHandler(warning_counter)