From 891b1cebb7b1e80df83753d56ccd711e6212186d Mon Sep 17 00:00:00 2001 From: Sebastian Qvarfordt Date: Wed, 29 Jul 2020 11:49:01 +0200 Subject: [PATCH] feature(techdocs-core): Initial version of metadata generation of mkdocs data --- packages/techdocs-container/Dockerfile | 2 +- .../techdocs-container/mock-docs/mkdocs.yml | 1 + .../techdocs-container/techdocs-core/setup.py | 2 +- .../techdocs-core/src/core.py | 17 +++++++++++++---- 4 files changed, 16 insertions(+), 6 deletions(-) diff --git a/packages/techdocs-container/Dockerfile b/packages/techdocs-container/Dockerfile index cfda62c51d..d5eec712a5 100644 --- a/packages/techdocs-container/Dockerfile +++ b/packages/techdocs-container/Dockerfile @@ -15,6 +15,6 @@ FROM python:3.7.7-alpine3.12 RUN apk update && apk --no-cache add gcc musl-dev -RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==0.0.2 mkdocs==1.1.2 mkdocs-material==5.3.2 mkdocs-monorepo-plugin==0.4.5 pymdown-extensions==7.1 +RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==0.0.3 mkdocs==1.1.2 mkdocs-material==5.3.2 mkdocs-monorepo-plugin==0.4.5 pymdown-extensions==7.1 ENTRYPOINT [ "mkdocs" ] diff --git a/packages/techdocs-container/mock-docs/mkdocs.yml b/packages/techdocs-container/mock-docs/mkdocs.yml index fca8418d12..8639c6abef 100644 --- a/packages/techdocs-container/mock-docs/mkdocs.yml +++ b/packages/techdocs-container/mock-docs/mkdocs.yml @@ -1,4 +1,5 @@ site_name: 'mock-docs' +site_description: 'mock-docs site description' nav: - Home: index.md diff --git a/packages/techdocs-container/techdocs-core/setup.py b/packages/techdocs-container/techdocs-core/setup.py index 9429409319..682825624c 100644 --- a/packages/techdocs-container/techdocs-core/setup.py +++ b/packages/techdocs-container/techdocs-core/setup.py @@ -18,7 +18,7 @@ from setuptools import setup, find_packages setup( name='mkdocs-techdocs-core', - version='0.0.2', + version='0.0.3', description='A Mkdocs package that contains TechDocs defaults', long_description='', keywords='mkdocs', diff --git a/packages/techdocs-container/techdocs-core/src/core.py b/packages/techdocs-container/techdocs-core/src/core.py index e6c4a0403d..6129979643 100644 --- a/packages/techdocs-container/techdocs-core/src/core.py +++ b/packages/techdocs-container/techdocs-core/src/core.py @@ -16,16 +16,25 @@ from mkdocs.plugins import BasePlugin, PluginCollection from mkdocs.theme import Theme - from mkdocs.contrib.search import SearchPlugin - from mkdocs_monorepo_plugin.plugin import MonorepoPlugin - +import tempfile +import os class TechDocsCore(BasePlugin): + def on_config(self, config): + fp = open(os.path.join(tempfile.gettempdir(), 'techdocs_metadata.json'), 'w+') + fp.write('{\n "site_name": "{{ config.site_name }}",\n "site_description": "{{ config.site_description }}"\n}') + # Theme - config["theme"] = Theme(name="material") + config["theme"] = Theme( + name="material", + static_templates=[ + "techdocs_metadata.json", + ], + ) + config["theme"].dirs.append(tempfile.gettempdir()) # Plugins del config["plugins"]["techdocs-core"]