From e3a1c1944b20fbd7c8575f7e365108cdeb6d8e3a Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 23 Jun 2020 16:57:16 +0200 Subject: [PATCH 1/3] feat(mkdocs) add mkdocs monorepo plugin to techdocs core plugin --- plugins/techdocs/mkdocs/container/Dockerfile | 2 +- .../mkdocs/container/techdocs-core/src/core.py | 18 ++++++++++++++---- plugins/techdocs/mkdocs/mock-docs/mkdocs.yml | 1 + .../mkdocs/mock-docs/sub-docs/docs/index.md | 1 + .../mkdocs/mock-docs/sub-docs/mkdocs.yml | 4 ++++ 5 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md create mode 100644 plugins/techdocs/mkdocs/mock-docs/sub-docs/mkdocs.yml diff --git a/plugins/techdocs/mkdocs/container/Dockerfile b/plugins/techdocs/mkdocs/container/Dockerfile index 8df86eadb0..aefabb5c5b 100644 --- a/plugins/techdocs/mkdocs/container/Dockerfile +++ b/plugins/techdocs/mkdocs/container/Dockerfile @@ -15,7 +15,7 @@ FROM python:3.7.7-alpine3.12 RUN apk update && apk --no-cache add gcc musl-dev -RUN pip install mkdocs==1.1.2 mkdocs-material==5.3.2 +RUN pip install mkdocs==1.1.2 mkdocs-material==5.3.2 mkdocs-monorepo-plugin==0.4.5 ADD ./techdocs-core /techdocs-core RUN pip install --no-index /techdocs-core diff --git a/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py b/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py index 7fce7d6dac..7fc35a1529 100644 --- a/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py +++ b/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py @@ -19,14 +19,24 @@ from mkdocs.theme import Theme from mkdocs.contrib.search import SearchPlugin +from mkdocs_monorepo_plugin.plugin import MonorepoPlugin class TechDocsCore(BasePlugin): def on_config(self, config): - # Theme - config["theme"] = Theme(name="material") + # Theme + config['theme'] = Theme(name="material") - # Plugins - del config["plugins"]["techdocs-core"] + # Plugins + del config['plugins']['techdocs-core'] + + search_plugin = SearchPlugin() + search_plugin.load_config({}) + + monorepo_plugin = MonorepoPlugin() + monorepo_plugin.load_config({}) + + config['plugins']['search'] = search_plugin + config['plugins']['monorepo'] = monorepo_plugin search_plugin = SearchPlugin() search_plugin.load_config({}) diff --git a/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml index b14d82c4de..3da0280f2b 100644 --- a/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml +++ b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml @@ -2,6 +2,7 @@ site_name: 'mock-docs' nav: - Home: index.md + - SubDocs: '!include ./sub-docs/mkdocs.yml' plugins: - techdocs-core diff --git a/plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md b/plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md new file mode 100644 index 0000000000..9cb6199605 --- /dev/null +++ b/plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md @@ -0,0 +1 @@ +### This is a md file in another docs folder using the [MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin) diff --git a/plugins/techdocs/mkdocs/mock-docs/sub-docs/mkdocs.yml b/plugins/techdocs/mkdocs/mock-docs/sub-docs/mkdocs.yml new file mode 100644 index 0000000000..09504c1b31 --- /dev/null +++ b/plugins/techdocs/mkdocs/mock-docs/sub-docs/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: subdocs + +nav: + - Home 2: "index.md" From 50c5489422420ee57d663783ed6e81e68f43ac1f Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Wed, 24 Jun 2020 12:00:24 +0200 Subject: [PATCH 2/3] fix(techdocs-core): formatting --- .../container/techdocs-core/src/core.py | 25 ++++++++++--------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py b/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py index 7fc35a1529..37d271d261 100644 --- a/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py +++ b/plugins/techdocs/mkdocs/container/techdocs-core/src/core.py @@ -21,22 +21,23 @@ from mkdocs.contrib.search import SearchPlugin from mkdocs_monorepo_plugin.plugin import MonorepoPlugin + class TechDocsCore(BasePlugin): def on_config(self, config): - # Theme - config['theme'] = Theme(name="material") + # Theme + config["theme"] = Theme(name="material") - # Plugins - del config['plugins']['techdocs-core'] - - search_plugin = SearchPlugin() - search_plugin.load_config({}) + # Plugins + del config["plugins"]["techdocs-core"] - monorepo_plugin = MonorepoPlugin() - monorepo_plugin.load_config({}) - - config['plugins']['search'] = search_plugin - config['plugins']['monorepo'] = monorepo_plugin + search_plugin = SearchPlugin() + search_plugin.load_config({}) + + monorepo_plugin = MonorepoPlugin() + monorepo_plugin.load_config({}) + + config["plugins"]["search"] = search_plugin + config["plugins"]["monorepo"] = monorepo_plugin search_plugin = SearchPlugin() search_plugin.load_config({}) From 72fed2555df5eb42eafae08251c972ead574cea8 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Wed, 24 Jun 2020 12:02:09 +0200 Subject: [PATCH 3/3] docs(sub-docs): typo --- plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md b/plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md index 9cb6199605..65c6644ef8 100644 --- a/plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md +++ b/plugins/techdocs/mkdocs/mock-docs/sub-docs/docs/index.md @@ -1 +1 @@ -### This is a md file in another docs folder using the [MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin) +### This is an md file in another docs folder using the [MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin)