def test_deploy_no_cname(self, mock_isfile, mock_import, get_remote,
get_sha, is_repo):
config = load_config(
remote_branch='test',
)
gh_deploy.gh_deploy(config)
def gh_deploy_command(config_file, clean):
"""Deply your documentation to GitHub Pages"""
config = load_config(
config_file=config_file
)
build.build(config, clean_site_dir=clean)
gh_deploy.gh_deploy(config)
def main(cmd, args, options=None):
"""
Build the documentation, and optionally start the devserver.
"""
clean_site_dir = 'clean' in options
if cmd == 'serve':
config = load_config(options=options)
serve(config, options=options)
elif cmd == 'build':
config = load_config(options=options)
build(config, clean_site_dir=clean_site_dir)
elif cmd == 'json':
config = load_config(options=options)
build(config, dump_json=True, clean_site_dir=clean_site_dir)
elif cmd == 'gh-deploy':
config = load_config(options=options)
build(config, clean_site_dir=clean_site_dir)
gh_deploy(config)
elif cmd == 'new':
new(args, options)
else:
config = load_config(options=options)
event = events.CLI(config, cmd, args, options)
event.broadcast()
if not event.consumed:
std = ['help', 'new', 'build', 'serve', 'gh-deply', 'json']
cmds = '|'.join(std + list(events.CLI.commands))
print('mkdocs [%s] {options}' % cmds)
def gh_deploy_command(config_file, clean, message, remote_branch):
"""Deply your documentation to GitHub Pages"""
config = load_config(
config_file=config_file,
remote_branch=remote_branch
)
build.build(config, clean_site_dir=clean)
gh_deploy.gh_deploy(config, message=message)
def gh_deploy_command(config_file, clean, message, remote_branch):
"""Deply your documentation to GitHub Pages"""
try:
config = load_config(
config_file=config_file,
remote_branch=remote_branch
)
build.build(config, clean_site_dir=clean)
gh_deploy.gh_deploy(config, message=message)
except exceptions.ConfigurationError as e:
# Avoid ugly, unhelpful traceback
raise SystemExit('\n' + str(e))
def gh_deploy_command(config_file, clean, message, remote_branch, remote_name):
"""Deploy your documentation to GitHub Pages"""
try:
config = load_config(
config_file=config_file,
remote_branch=remote_branch,
remote_name=remote_name
)
build.build(config, clean_site_dir=clean)
gh_deploy.gh_deploy(config, message=message)
except exceptions.ConfigurationError as e:
# Avoid ugly, unhelpful traceback
raise SystemExit('\n' + str(e))
def docs_deploy(DOCS_ROOT=None, **ctx):
""" """
import mkdocs
from mkdocs.config import load_config
from mkdocs.gh_deploy import gh_deploy
mkdocs_config = os.path.join(DOCS_ROOT, 'mkdocs.yml')
assert os.path.exists(mkdocs_config)
os.chdir(DOCS_ROOT)
try:
config = load_config(
config_file=mkdocs_config,
)
gh_deploy(config)
except mkdocs.exceptions.ConfigurationError as e:
# Avoid ugly, unhelpful traceback
raise SystemExit('\n' + str(e))
def main(cmd, args, options=None):
"""
Build the documentation, and optionally start the devserver.
"""
if cmd == 'serve':
config = load_config(options=options)
serve(config, options=options)
elif cmd == 'build':
config = load_config(options=options)
build(config)
elif cmd == 'gh-deploy':
config = load_config(options=options)
build(config)
gh_deploy(config)
elif cmd == 'new':
new(args, options)
else:
print('mkdocs [help|new|build|serve|gh-deploy] {options}')
def main(cmd, args, options=None):
"""
Build the documentation, and optionally start the devserver.
"""
if cmd == 'serve':
config = load_config(options=options)
serve(config, options=options)
elif cmd == 'build':
config = load_config(options=options)
build(config)
elif cmd == 'json':
config = load_config(options=options)
build(config, dump_json=True)
elif cmd == 'gh-deploy':
config = load_config(options=options)
build(config)
gh_deploy(config)
elif cmd == 'new':
new(args, options)
else:
print('mkdocs [help|new|build|serve|gh-deploy|json] {options}')
def main(cmd, args, options=None):
"""
Build the documentation, and optionally start the devserver.
"""
clean_site_dir = 'clean' in options
if cmd == 'serve':
config = load_config(options=options)
serve(config, options=options)
elif cmd == 'build':
config = load_config(options=options)
build(config, clean_site_dir=clean_site_dir)
elif cmd == 'json':
config = load_config(options=options)
build(config, dump_json=True, clean_site_dir=clean_site_dir)
elif cmd == 'gh-deploy':
config = load_config(options=options)
build(config, clean_site_dir=clean_site_dir)
gh_deploy(config)
elif cmd == 'new':
new(args, options)
else:
print('mkdocs [help|new|build|serve|gh-deploy|json] {options}')
def main(cmd, args, options=None):
"""
Build the documentation, and optionally start the devserver.
"""
clean_site_dir = 'clean' in options
if cmd == 'serve':
config = load_config(options=options)
serve(config, options=options)
elif cmd == 'build':
config = load_config(options=options)
build(config, clean_site_dir=clean_site_dir)
elif cmd == 'json':
config = load_config(options=options)
build(config, dump_json=True, clean_site_dir=clean_site_dir)
elif cmd == 'gh-deploy':
config = load_config(options=options)
build(config, clean_site_dir=clean_site_dir)
gh_deploy(config)
elif cmd == 'new':
new(args, options)
else:
print('MkDocs (version {0})'.format(__version__))
print('mkdocs [help|new|build|serve|gh-deploy|json] {options}')
def test_deploy_hostname(self, mock_import, get_remote, get_sha, is_repo):
config = load_config(remote_branch='test', )
gh_deploy.gh_deploy(config)
def gh_deploy_command(config_file, clean, message, remote_branch):
"""Deply your documentation to GitHub Pages"""
config = load_config(config_file=config_file, remote_branch=remote_branch)
build.build(config, clean_site_dir=clean)
gh_deploy.gh_deploy(config, message=message)
