From 49eccdd76154c16ba3648326ae04696290d10a24 Mon Sep 17 00:00:00 2001 From: Richard Conway Date: Tue, 16 Apr 2024 13:51:07 +0100 Subject: [PATCH] Align to doc template --- docs/css/eoepca.css | 21 +++++++++++++++++++++ docs/requirements.txt | 2 ++ mkdocs.yml | 39 +++++++++++++++++---------------------- 3 files changed, 40 insertions(+), 22 deletions(-) create mode 100644 docs/css/eoepca.css diff --git a/docs/css/eoepca.css b/docs/css/eoepca.css new file mode 100644 index 00000000..4e60d274 --- /dev/null +++ b/docs/css/eoepca.css @@ -0,0 +1,21 @@ +.green-text { + color: green; +} + +.blue-text { + color: steelblue; +} + +.yellow-text { + color: #F6BE00; +} + +.grey-text { + color: grey; +} + +img.centered { + display: block; + margin-left: auto; + margin-right: auto; +} diff --git a/docs/requirements.txt b/docs/requirements.txt index ec6fd45e..6015aa76 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,3 @@ mkdocs-material==9.5.17 +mkdocs-autorefs==1.0.1 +mkdocs-publisher==1.2.0 diff --git a/mkdocs.yml b/mkdocs.yml index 9a7004ce..4d82f2fd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: EOEPCA Deployment Guide -site_url: https://deployment-guide.docs.eoepca.org +site_url: https://eoepca.readthedocs.io/projects/deploy/en/stable/ repo_url: https://github.com/EOEPCA/deployment-guide -edit_uri: "" +edit_uri: "edit/main/docs/" # Site navigation nav: @@ -72,6 +72,21 @@ theme: # - toc.integrate - navigation.top - content.code.copy + - content.action.edit + +extra_css: + - css/eoepca.css + +plugins: + - autorefs + # - pub-debugger: + # console_log: + # enabled: true + # log_level: INFO + # file_log: + # enabled: false + # zip_log: + # enabled: false markdown_extensions: - tables @@ -97,23 +112,3 @@ markdown_extensions: extra: version: provider: mike - -# docs_dir: docs -# site_dir: site -# extra_css: -# - css/extra.css -# - css/second_extra.css -# extra_javascript: [] -# extra_templates: [] -# extra: {} -# use_directory_urls: true -# strict: false -# dev_addr: 127.0.0.1:8000 -# plugins: -# - search: -# separator: '[\s\-\.]+' -# min_search_length: 3 -# lang: en -# prebuild_index: False -# indexing: full -# - your_other_plugin