Skip to content

clean up config formatting and simplify inline comments #5758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kazisufiyan-k2 wants to merge 1 commit into from
+55 −59
Closed

clean up config formatting and simplify inline comments #5758

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 55 additions & 59 deletions mkdocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,88 +1,84 @@
# === Site Metadata ===
site_name: Deep Learning Containers # Browser tab title & header
site_description: Documentation for AWS Deep Learning Containers # SEO meta description
site_url: https://aws.github.io/deep-learning-containers # Canonical URL (for sitemap, SEO)
site_name: Deep Learning Containers
site_description: Documentation for AWS Deep Learning Containers
site_url: https://aws.github.io/deep-learning-containers

# === GitHub Integration ===
repo_name: aws/deep-learning-containers # Displayed name for repo link
repo_url: https://github.com/aws/deep-learning-containers # Links to GitHub (top-right corner)
repo_name: aws/deep-learning-containers
repo_url: https://github.com/aws/deep-learning-containers

exclude_docs: |
src/*
*.template.md

# === Hooks ===
hooks:
- docs/src/hooks.py # Auto-generate docs from YAML
- docs/src/hooks.py # auto-generate docs from YAML at build time

theme:
name: material # Use Material for MkDocs theme
logo: assets/logos/AWS_logo_RGB.svg # Logo in page
favicon: assets/logos/AWS_logo_RGB.svg # Browse tab icon
name: material
logo: assets/logos/AWS_logo_RGB.svg
favicon: assets/logos/AWS_logo_RGB.svg

palette:
# Auto mode - follows system preference
- media: "(prefers-color-scheme)" # Follows system preference color
- media: "(prefers-color-scheme)" # follows system preference
toggle:
icon: material/brightness-auto
name: Switch to light mode # Toggle button label system -> light
# Light mode
- media: "(prefers-color-scheme: light)" # Set to light mode
name: Switch to light mode

- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/brightness-5
name: Switch to dark mode # Toggle button label light -> dark
# Dark mode
name: Switch to dark mode

- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom # Header/nav bar color
accent: custom # Links/buttons highlight color
primary: custom
accent: custom
toggle:
icon: material/brightness-3
name: Switch to system preference # Toggle button label dark -> system
name: Switch to system preference

features:
- content.code.copy # Copy button on code blocks
- content.tabs.link # Sync tab selection across page
- navigation.instant # SPA-like navigation (no full reload)
- navigation.instant.progress # Loading progress bar
- navigation.tracking # URL updates as you scroll
- navigation.tabs # Top-level sections as tabs
- navigation.tabs.sticky # Tabs stay visible when scrolling
- navigation.sections # Group items in sidebar
- navigation.top # "Back to top" button
- search.highlight # Highlight search matches on page
- search.share # Share search results via URL
- toc.follow # TOC follows scroll position
- content.code.copy # copy button on all code blocks
- content.tabs.link # sync tab selections across the page
- navigation.instant # SPA-like navigation, no full page reload
- navigation.instant.progress # loading progress bar for slow pages
- navigation.tracking # URL updates as user scrolls
- navigation.tabs # top-level sections rendered as tabs
- navigation.tabs.sticky # tabs stay visible while scrolling
- navigation.sections # group nav items in collapsible sections
- navigation.top # back-to-top button on long pages
- search.highlight # highlight search matches on the page
- search.share # shareable search result URLs
- toc.follow # TOC sidebar follows scroll position

icon:
repo: fontawesome/brands/github # GitHub icon for repo link
repo: fontawesome/brands/github

# === Markdown Extensions ===
markdown_extensions:
- attr_list # Add HTML attributes to elements
- md_in_html # Markdown inside HTML blocks
- admonition # Note/warning/tip boxes (signify by !!! note)
- pymdownx.details # Collapsible admonitions (signify by ??? note)
- pymdownx.superfences # Nested code blocks, diagrams
- pymdownx.tabbed: # Tabbed content blocks
alternate_style: true # Modern tab styling
- pymdownx.highlight: # Syntax highlighting for code
anchor_linenums: true # Linkable line numbers
line_spans: __span # Wrap lines in spans
pygments_lang_class: true # Add language class to code blocks
- tables # Markdown tables support
- toc: # Table of contents
permalink: true # Add permalink anchors to headings
- attr_list
- md_in_html
- tables
- admonition # !!! note / warning / tip boxes
- pymdownx.details # ??? note — collapsible blocks
- pymdownx.superfences # nested code blocks and mermaid diagrams
- pymdownx.highlight:
anchor_linenums: true # makes line numbers linkable via URL
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true # required for material theme tabs
- toc:
permalink: true # adds anchor link to every heading

# === Plugins ===
plugins:
- meta # Page metadata from YAML front matter
- search # Built-in search
- autorefs # Auto-link to other pages/headings
- awesome-nav # .nav.yml file support
- macros: # Variable substitution in markdown
module_name: docs/src/macros
- meta
- search
- autorefs
- awesome-nav
- macros:
module_name: docs/src/macros # variable substitution in markdown

# === Custom Assets ===
extra_css:
- mkdocs/stylesheets/extra.css # Custom CSS overrides
- mkdocs/stylesheets/extra.css # custom CSS overrides for AWS branding