def on_serve(
self,
server: LiveReloadServer,
config: Config,
builder: Callable[[], None],
**kw: Any
) -> LiveReloadServer:
self._build(config)
# add watching path.
module_path = self.config["module"].replace(".", "/")
server.watch(module_path)
return server
def on_serve(
self,
server: LiveReloadServer,
config: Config,
builder,
) -> LiveReloadServer:
inference_directory = Path(config['docs_dir']).parent / 'inference'
if inference_directory.is_dir():
for sparql_file in inference_directory.glob('**/*.sparql'):
server.watch(str(sparql_file), builder)
queries_directory = Path(config['docs_dir']).parent / 'queries'
if queries_directory.is_dir():
for sparql_file in queries_directory.glob('**/*.sparql'):
server.watch(str(sparql_file), builder)
return server
def testing_server(root, builder=lambda: None, mount_path="/"):
"""Create the server and start most of its parts, but don't listen on a socket."""
with mock.patch("socket.socket"):
server = LiveReloadServer(
builder,
host="localhost",
port=0,
root=root,
mount_path=mount_path,
polling_interval=0.2,
bind_and_activate=False,
)
server.setup_environ()
server.observer.start()
thread = threading.Thread(target=server._build_loop, daemon=True)
thread.start()
yield server
server.shutdown()
thread.join()
def serve(config_file=None, dev_addr=None, strict=None, theme=None,
theme_dir=None, livereload='livereload', watch_theme=False, watch=[], **kwargs):
"""
Start the MkDocs development server
By default it will serve the documentation on http://localhost:8000/ and
it will rebuild the documentation and refresh the page automatically
whenever a file is edited.
"""
# Create a temporary build directory, and set some options to serve it
# PY2 returns a byte string by default. The Unicode prefix ensures a Unicode
# string is returned. And it makes MkDocs temp dirs easier to identify.
site_dir = tempfile.mkdtemp(prefix='mkdocs_')
def mount_path(config):
return urlsplit(config['site_url'] or '/').path
def builder():
log.info("Building documentation...")
config = load_config(
config_file=config_file,
dev_addr=dev_addr,
strict=strict,
theme=theme,
theme_dir=theme_dir,
site_dir=site_dir,
**kwargs
)
# combine CLI watch arguments with config file values
if config["watch"] is None:
config["watch"] = watch
else:
config["watch"].extend(watch)
# Override a few config settings after validation
config['site_url'] = 'http://{}{}'.format(config['dev_addr'], mount_path(config))
live_server = livereload in ['dirty', 'livereload']
dirty = livereload == 'dirty'
build(config, live_server=live_server, dirty=dirty)
return config
try:
# Perform the initial build
config = builder()
host, port = config['dev_addr']
server = LiveReloadServer(builder=builder, host=host, port=port, root=site_dir, mount_path=mount_path(config))
def error_handler(code):
if code in (404, 500):
error_page = join(site_dir, f'{code}.html')
if isfile(error_page):
with open(error_page, 'rb') as f:
return f.read()
server.error_handler = error_handler
if livereload in ['livereload', 'dirty']:
# Watch the documentation files, the config file and the theme files.
server.watch(config['docs_dir'])
server.watch(config['config_file_path'])
if watch_theme:
for d in config['theme'].dirs:
server.watch(d)
# Run `serve` plugin events.
server = config['plugins'].run_event('serve', server, config=config, builder=builder)
for item in config['watch']:
server.watch(item)
try:
server.serve()
except KeyboardInterrupt:
log.info("Shutting down...")
finally:
server.shutdown()
except jinja2.exceptions.TemplateError:
# This is a subclass of OSError, but shouldn't be suppressed.
raise
except OSError as e: # pragma: no cover
# Avoid ugly, unhelpful traceback
raise Abort(f'{type(e).__name__}: {e}')
finally:
if isdir(site_dir):
shutil.rmtree(site_dir)