From ca51e4c5442884c4ec3e3463dd74724f120dae04 Mon Sep 17 00:00:00 2001 From: Alexandre Vicenzi Date: Sat, 19 Sep 2020 22:04:09 +0200 Subject: [PATCH] Black format --- docs/pelicanconf.py | 66 ++++++++++++++++++++++--------------------- docs/publishconf.py | 22 +++++++-------- docs/tasks.py | 69 +++++++++++++++++++++++++-------------------- 3 files changed, 84 insertions(+), 73 deletions(-) diff --git a/docs/pelicanconf.py b/docs/pelicanconf.py index 04c2919..e6055b4 100644 --- a/docs/pelicanconf.py +++ b/docs/pelicanconf.py @@ -1,22 +1,22 @@ from datetime import datetime -AUTHOR = 'Alexandre Vicenzi' -SITEURL = 'http://localhost:8000' -SITENAME = 'Flex' -SITETITLE = 'Flex' -SITESUBTITLE = 'The minimalist Pelican theme' -SITEDESCRIPTION = 'Flex - The minimalist Pelican theme.' +AUTHOR = "Alexandre Vicenzi" +SITEURL = "http://localhost:8000" +SITENAME = "Flex" +SITETITLE = "Flex" +SITESUBTITLE = "The minimalist Pelican theme" +SITEDESCRIPTION = "Flex - The minimalist Pelican theme." # SITELOGO = '' # FAVICON = '/images/favicon.ico' -BROWSER_COLOR = '#333333' -PYGMENTS_STYLE = 'monokai' +BROWSER_COLOR = "#333333" +PYGMENTS_STYLE = "monokai" -ROBOTS = 'index, follow' +ROBOTS = "index, follow" -THEME = '../' -PATH = 'content' -OUTPUT_PATH = 'blog/' -TIMEZONE = 'America/New_York' +THEME = "../" +PATH = "content" +OUTPUT_PATH = "blog/" +TIMEZONE = "America/New_York" # PLUGIN_PATHS = ['pelican-plugins'] @@ -24,17 +24,17 @@ TIMEZONE = 'America/New_York' # JINJA_ENVIRONMENT = {'extensions': ['jinja2.ext.i18n']} -I18N_TEMPLATES_LANG = 'en' -DEFAULT_LANG = 'en' -OG_LOCALE = 'en_US' -LOCALE = 'en_US' +I18N_TEMPLATES_LANG = "en" +DEFAULT_LANG = "en" +OG_LOCALE = "en_US" +LOCALE = "en_US" DATE_FORMATS = { - 'en': '%B %d, %Y', + "en": "%B %d, %Y", } -FEED_ALL_ATOM = 'feeds/all.atom.xml' -CATEGORY_FEED_ATOM = 'feeds/{slug}.atom.xml' +FEED_ALL_ATOM = "feeds/all.atom.xml" +CATEGORY_FEED_ATOM = "feeds/{slug}.atom.xml" TRANSLATION_FEED_ATOM = None AUTHOR_FEED_ATOM = None AUTHOR_FEED_RSS = None @@ -44,31 +44,33 @@ MAIN_MENU = True HOME_HIDE_TAGS = True SOCIAL = ( - ('github', 'https://github.com/alexandrevicenzi/Flex'), - ('rss', '/blog/feeds/all.atom.xml'), + ("github", "https://github.com/alexandrevicenzi/Flex"), + ("rss", "/blog/feeds/all.atom.xml"), ) -MENUITEMS = (('Archives', '/archives.html'), - ('Categories', '/categories.html'), - ('Tags', '/tags.html'),) +MENUITEMS = ( + ("Archives", "/archives.html"), + ("Categories", "/categories.html"), + ("Tags", "/tags.html"), +) CC_LICENSE = { - 'name': 'Creative Commons Attribution-ShareAlike', - 'version': '4.0', - 'slug': 'by-sa' + "name": "Creative Commons Attribution-ShareAlike", + "version": "4.0", + "slug": "by-sa", } COPYRIGHT_YEAR = datetime.now().year DEFAULT_PAGINATION = 10 DISQUS_SITENAME = "flex-pelican" -ADD_THIS_ID = 'ra-55adbb025d4f7e55' +ADD_THIS_ID = "ra-55adbb025d4f7e55" -STATIC_PATHS = ['images', 'extra/ads.txt', 'extra/CNAME'] +STATIC_PATHS = ["images", "extra/ads.txt", "extra/CNAME"] EXTRA_PATH_METADATA = { - 'extra/ads.txt': {'path': 'ads.txt'}, - 'extra/CNAME': {'path': 'CNAME'}, + "extra/ads.txt": {"path": "ads.txt"}, + "extra/CNAME": {"path": "CNAME"}, } THEME_COLOR_AUTO_DETECT_BROWSER_PREFERENCE = True diff --git a/docs/publishconf.py b/docs/publishconf.py index 6f4168a..6c0fb89 100644 --- a/docs/publishconf.py +++ b/docs/publishconf.py @@ -9,7 +9,7 @@ except ImportError: sys.path.append(os.path.join(os.curdir, "docs")) from pelicanconf import * -SITEURL = 'https://flex.alxd.me/' +SITEURL = "https://flex.alxd.me/" RELATIVE_URLS = False @@ -18,14 +18,14 @@ USE_LESS = False GOOGLE_ANALYTICS = "UA-55543164-6" GOOGLE_ADSENSE = { - 'ca_id': 'ca-pub-6625957038449899', - 'page_level_ads': True, - 'ads': { - 'aside': '8752710348', - 'main_menu': '', - 'index_top': '', - 'index_bottom': '1124188687', - 'article_top': '', - 'article_bottom': '4843941849', - } + "ca_id": "ca-pub-6625957038449899", + "page_level_ads": True, + "ads": { + "aside": "8752710348", + "main_menu": "", + "index_top": "", + "index_bottom": "1124188687", + "article_top": "", + "article_bottom": "4843941849", + }, } diff --git a/docs/tasks.py b/docs/tasks.py index 4708467..109c47a 100644 --- a/docs/tasks.py +++ b/docs/tasks.py @@ -10,45 +10,50 @@ from invoke.util import cd from pelican.server import ComplexHTTPRequestHandler, RootedHTTPServer from pelican.settings import DEFAULT_CONFIG, get_settings_from_file -SETTINGS_FILE_BASE = 'pelicanconf.py' +SETTINGS_FILE_BASE = "pelicanconf.py" SETTINGS = {} SETTINGS.update(DEFAULT_CONFIG) LOCAL_SETTINGS = get_settings_from_file(SETTINGS_FILE_BASE) SETTINGS.update(LOCAL_SETTINGS) CONFIG = { - 'settings_base': SETTINGS_FILE_BASE, - 'settings_publish': 'publishconf.py', + "settings_base": SETTINGS_FILE_BASE, + "settings_publish": "publishconf.py", # Output path. Can be absolute or relative to tasks.py. Default: 'output' - 'deploy_path': SETTINGS['OUTPUT_PATH'], + "deploy_path": SETTINGS["OUTPUT_PATH"], # Github Pages configuration - 'github_pages_branch': 'gh-pages', - 'commit_message': "'Publish site on {}'".format(datetime.date.today().isoformat()), + "github_pages_branch": "gh-pages", + "commit_message": "'Publish site on {}'".format(datetime.date.today().isoformat()), # Port for `serve` - 'port': 8000, + "port": 8000, } + @task def clean(c): """Remove generated files""" - if os.path.isdir(CONFIG['deploy_path']): - shutil.rmtree(CONFIG['deploy_path']) - os.makedirs(CONFIG['deploy_path']) + if os.path.isdir(CONFIG["deploy_path"]): + shutil.rmtree(CONFIG["deploy_path"]) + os.makedirs(CONFIG["deploy_path"]) + @task def build(c): """Build local version of site""" - c.run('pelican -s {settings_base}'.format(**CONFIG)) + c.run("pelican -s {settings_base}".format(**CONFIG)) + @task def rebuild(c): """`build` with the delete switch""" - c.run('pelican -d -s {settings_base}'.format(**CONFIG)) + c.run("pelican -d -s {settings_base}".format(**CONFIG)) + @task def regenerate(c): """Automatically regenerate site upon file modification""" - c.run('pelican -r -s {settings_base}'.format(**CONFIG)) + c.run("pelican -r -s {settings_base}".format(**CONFIG)) + @task def serve(c): @@ -58,55 +63,59 @@ def serve(c): allow_reuse_address = True server = AddressReuseTCPServer( - CONFIG['deploy_path'], - ('', CONFIG['port']), - ComplexHTTPRequestHandler) + CONFIG["deploy_path"], ("", CONFIG["port"]), ComplexHTTPRequestHandler + ) - sys.stderr.write('Serving on port {port} ...\n'.format(**CONFIG)) + sys.stderr.write("Serving on port {port} ...\n".format(**CONFIG)) server.serve_forever() + @task def reserve(c): """`build`, then `serve`""" build(c) serve(c) + @task def preview(c): """Build production version of site""" - c.run('pelican -s {settings_publish}'.format(**CONFIG)) + c.run("pelican -s {settings_publish}".format(**CONFIG)) + @task def livereload(c): """Automatically reload browser tab upon file modification.""" from livereload import Server + build(c) server = Server() # Watch the base settings file - server.watch(CONFIG['settings_base'], lambda: build(c)) + server.watch(CONFIG["settings_base"], lambda: build(c)) # Watch content source files - content_file_extensions = ['.md', '.rst'] + content_file_extensions = [".md", ".rst"] for extension in content_file_extensions: - content_blob = '{0}/**/*{1}'.format(SETTINGS['PATH'], extension) + content_blob = "{0}/**/*{1}".format(SETTINGS["PATH"], extension) server.watch(content_blob, lambda: build(c)) # Watch the theme's templates and static assets - theme_path = SETTINGS['THEME'] - server.watch('{}/templates/*.html'.format(theme_path), lambda: build(c)) - static_file_extensions = ['.css', '.js'] + theme_path = SETTINGS["THEME"] + server.watch("{}/templates/*.html".format(theme_path), lambda: build(c)) + static_file_extensions = [".css", ".js"] for extension in static_file_extensions: - static_file = '{0}/static/**/*{1}'.format(theme_path, extension) + static_file = "{0}/static/**/*{1}".format(theme_path, extension) server.watch(static_file, lambda: build(c)) # Serve output path on configured port - server.serve(port=CONFIG['port'], root=CONFIG['deploy_path']) + server.serve(port=CONFIG["port"], root=CONFIG["deploy_path"]) @task def publish(c): """Publish to production via rsync""" - c.run('pelican -s {settings_publish}'.format(**CONFIG)) + c.run("pelican -s {settings_publish}".format(**CONFIG)) c.run( 'rsync --delete --exclude ".DS_Store" -pthrvz -c ' '-e "ssh -p {ssh_port}" ' - '{} {ssh_user}@{ssh_host}:{ssh_path}'.format( - CONFIG['deploy_path'].rstrip('/') + '/', - **CONFIG)) + "{} {ssh_user}@{ssh_host}:{ssh_path}".format( + CONFIG["deploy_path"].rstrip("/") + "/", **CONFIG + ) + )