def test_build_extra_template(self):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'],
cfg['use_directory_urls']),
])
build._build_extra_template('foo.html', files, cfg, mock.Mock())
def test_skip_extra_template_empty_output(self):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']),
])
with self.assertLogs('mkdocs', level='INFO') as cm:
build._build_extra_template('foo.html', files, cfg, mock.Mock())
self.assertEqual(
cm.output,
["INFO:mkdocs.commands.build:Template skipped: 'foo.html' generated empty output."]
)
def test_skip_ioerror_extra_template(self, mock_open):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']),
])
with self.assertLogs('mkdocs', level='INFO') as cm:
build._build_extra_template('foo.html', files, cfg, mock.Mock())
self.assertEqual(
cm.output,
["WARNING:mkdocs.commands.build:Error reading template 'foo.html': Error message."]
)
def test_skip_missing_extra_template(self):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']),
])
with self.assertLogs('mkdocs', level='INFO') as cm:
build._build_extra_template('missing.html', files, cfg, mock.Mock())
self.assertEqual(
cm.output,
["WARNING:mkdocs.commands.build:Template skipped: 'missing.html' not found in docs_dir."]
)
def test_skip_extra_template_empty_output(self):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']),
])
with self.assertLogs('mkdocs', level='INFO') as cm:
build._build_extra_template('foo.html', files, cfg, mock.Mock())
self.assertEqual(
cm.output,
["INFO:mkdocs.commands.build:Template skipped: 'foo.html' generated empty output."]
)
def test_skip_ioerror_extra_template(self, mock_open):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']),
])
with self.assertLogs('mkdocs', level='INFO') as cm:
build._build_extra_template('foo.html', files, cfg, mock.Mock())
self.assertEqual(
cm.output,
["WARNING:mkdocs.commands.build:Error reading template 'foo.html': Error message."]
)
def test_skip_missing_extra_template(self):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']),
])
with self.assertLogs('mkdocs', level='INFO') as cm:
build._build_extra_template('missing.html', files, cfg, mock.Mock())
self.assertEqual(
cm.output,
["WARNING:mkdocs.commands.build:Template skipped: 'missing.html' not found in docs_dir."]
)
def build(config, live_server=False, dirty=False):
""" Perform a full site build. """
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)
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("Building site to directory: %s", config['site_dir'])
if dirty and mkdocs_build.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 = mkdocs_build.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("Reading: " + file.src_path)
mkdocs_build._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.
for f in files:
print(f.page)
log.debug("Copying static assets.")
files.copy_static_files(dirty=dirty)
for template in config['theme'].static_templates:
mkdocs_build._build_theme_template(template, env, files, config, nav)
for template in config['extra_templates']:
mkdocs_build._build_extra_template(template, files, config, nav)
log.debug("Building markdown pages.")
for file in files.documentation_pages():
mkdocs_build._build_page(file.page, config, files, nav, env, dirty)
# Run `post_build` plugin events.
config['plugins'].run_event('post_build', config)
if config['strict'] and utils.warning_filter.count:
raise SystemExit('\nExited with {} warnings in strict mode.'.format(
utils.warning_filter.count))
log.info('site built in %.2f seconds', time() - start)
def test_build_extra_template(self):
cfg = load_config()
files = Files([
File('foo.html', cfg['docs_dir'], cfg['site_dir'], cfg['use_directory_urls']),
])
build._build_extra_template('foo.html', files, cfg, mock.Mock())
