applied-computing-foundations/mkdocs.yaml at main · denisecase/applied-computing-foundations · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# ============================================================
# mkdocs.yaml (MkDocs configuration file)
# ============================================================

# REQ.PROJECT: MkDocs configuration file (mkdocs.yaml)
#      to automatically build an associated website
#      for professional project documentation and communication.
#      Requires:
#         1. this file in the root of your project repository
#         2. docs/ folder with markdown files (.md) for content
#         3. GitHub Actions workflow to build and deploy site (in .github/workflows/)
#
# WHY-FILE: This data file provides the site structure and settings

site_name: "Project Documentation"
#TODO: Change to your GitHub Pages URL.
site_url: https://denisecase.github.io/applied-computing-foundations/
#TODO: Change to your GitHub repository URL.
repo_url: https://github.com/denisecase/applied-computing-foundations
site_description: Project documentation.
docs_dir: docs
site_dir: site
extra:
  social:
    - icon: fontawesome/brands/github
      #TODO: Change to your GitHub repository URL.
      link: https://github.com/denisecase/applied-computing-foundations

# WHY: Material theme is industry standard, well-documented
theme:
  name: material
  features:
    - navigation.tabs # Top-level nav as tabs
    - navigation.tabs.sticky # Keep tabs visible when scrolling
    - navigation.expand
    - navigation.top # Back-to-top button
    - search.suggest # Search suggestions while typing
    - search.highlight # Highlight search terms
    - content.code.copy # Copy button on code blocks
    - toc.follow # Highlight current section in TOC

  palette:
    - scheme: default # Light/dark mode toggle
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search # WHY: Built-in search functionality
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src/python/src
          options:
            show_source: true
            show_root_heading: true # Include module names
            show_root_toc_entry: true # Include module in TOC
            docstring_style: google # Professional docstring format
            show_signature_annotations: true
            separate_signature: true # Makes function signatures easier to read

nav:
  - Home: index.md
  - Glossary: glossary.md
  - How to take Screenshots: how_to_take_screenshots.md
  - Repos/ on Mac/Linux: repos_on_mac_linux.md
  - Repos/ on Windows: repos_on_windows.md
  - Terminals: terminals.md