From 37938e8cd333860375aac138c9624e6a27f510be Mon Sep 17 00:00:00 2001 From: konstantinos Date: Wed, 15 Nov 2023 23:26:23 +0200 Subject: [PATCH] docs: update content and set material theme --- docs/cicd.md | 5 ++++ mkdocs.yml | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 74 insertions(+), 1 deletion(-) diff --git a/docs/cicd.md b/docs/cicd.md index 4f69887..734e94d 100644 --- a/docs/cicd.md +++ b/docs/cicd.md @@ -1,3 +1,8 @@ +--- +tags: + - CICD +--- + ## CICD Pipeline, as single Github Action Workflow Flow Chart, of how the Jobs are connected in the Pipelinebuild). diff --git a/mkdocs.yml b/mkdocs.yml index 0132e85..1bd9139 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,9 +1,72 @@ site_name: Artificial Artwork -repo_name: neural-style-transfer +site_url: https://neural-style-transfer.readthedocs.io/ +site_description: Neural Style Transfer Project Documentation. +site_author: Konstantinos Lampridis + +repo_url: https://github.com/boromir674/neural-style-transfer/ +repo_name: boromir674/neural-style-transfer +edit_uri: blob/master/docs/ + +theme: + # 1 + name: material + icon: + logo: material/palette + previous: fontawesome/solid/angle-left + next: fontawesome/solid/angle-right + default: material/tag + + # favicon: images/favicon.png + features: + - navigation.path + - navigation.top + - navigation.footer + # - navigation.indexes + # navigation.instant break mermaid + # features: + # - navigation.tracking + + # - navigation.instant + + # 2 + # name: mkdocs + # # nav_style: dark + # locale: en + # highlightjs: true + # hljs_languages: + # - python + # - bash + # - yaml + # - json + # shortcuts: + # help: 191 # ? + # next: 78 # n + # previous: 80 # p + # search: 83 # s + + # 3 +# name: readthedocs + plugins: + # Authors need installation + # - git-authors + - tags: + tags_file: tags.md + # BASIC SEARCH PLUGIN - search + # MERMAID Render Support - mermaid2 + # Directives Provider for docstrings parsing - mkdocstrings + # - mkdocstrings: + # handlers: + # python: + # options: + # docstring_section_style: list + # # members_order: source + # show_root_heading: false + # show_source: true + # show_signature_annotations: true - gen-files: scripts: - scripts/gen_api_refs_pages.py @@ -23,3 +86,8 @@ nav: - "Docker": build-process_DAG.md - "CICD": cicd.md - Code Reference: reference/ + - tags: tags.md + + +extra: + generator: false