Skip to content

Commit

Permalink
docs: update content and set material theme
Browse files Browse the repository at this point in the history
  • Loading branch information
boromir674 committed Nov 15, 2023
1 parent 8d85882 commit 37938e8
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/cicd.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
tags:
- CICD
---

## CICD Pipeline, as single Github Action Workflow

Flow Chart, of how the Jobs are connected in the Pipelinebuild).
Expand Down
70 changes: 69 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -23,3 +86,8 @@ nav:
- "Docker": build-process_DAG.md
- "CICD": cicd.md
- Code Reference: reference/
- tags: tags.md


extra:
generator: false

0 comments on commit 37938e8

Please sign in to comment.