package-your-code-workshop/mkdocs.yml at main · nhsengland/package-your-code-workshop · 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
site_name: Package Your Code Workshop
site_description: NHS Data Science Workshop - Package Your Code
site_author: Joseph Wilson - NHS England - Data Science and Applied AI Team
site_url: https://nhsengland.github.io/package-your-code-workshop
repo_url: https://github.com/nhsengland/package-your-code-workshop
repo_name: package-your-code-workshop
edit_uri: edit/main/docs/content/
docs_dir: docs/content

theme:
  name: material
  language: en
  custom_dir: docs/overrides
  palette:
    scheme: default
    primary: indigo
  font:
    text: Roboto
  logo: images/logo/nhs-blue-on-white.jpg
  favicon: images/favicon/favicon.ico
  features:
    - search.share
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.path
    - navigation.top
    - toc.integrate
  icon:
    admonition:
      <type>: material/alert

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            members_order: source
            show_source: true
            show_bases: true
            extra:
              show_inheritance: true

nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Workshop Presentation:
    - workshop_presentation/index.md
    - Open Up The Repository: workshop_presentation/open_up_the_repository.md
    - Who am I: workshop_presentation/who_am_i.md
    - Workshop Context - Why is any of this important?: workshop_presentation/workshop_context.md
    - Opinions and Disclaimers: workshop_presentation/opinions_and_disclaimers.md
  - Workshops:
    - workshops/index.md
    - Dependency Management: workshops/dependency_management.md
    - Packaging with pyproject.toml: workshops/packaging_pyproject.md
    - Documentation with MkDocs: workshops/mkdocs_documentation.md
    - Bonus Content:
      - Cookiecutter Templates: workshops/cookiecutter_templates.md
      - Pre-Commit Hooks: workshops/precommit_hooks.md
      - CI/CD with GitHub Actions: workshops/github_actions.md
  - API Reference:
    - api_reference/index.md

extra_css:
  - stylesheets/nhs_style.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/nhsengland/package-your-code-workshop
    - icon: fontawesome/solid/envelope
      link: mailto:datascience@nhs.net
  generator: false

copyright: Copyright &copy; 2025 Crown Copyright (NHS England)

markdown_extensions:
  - tables
  - attr_list
  - pymdownx.emoji
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - admonition
  - pymdownx.details
  - pymdownx.mark
  - md_in_html
  - footnotes
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.tilde

extra_javascript:
  - javascripts/mermaid.mjs

watch:
  - docs/overrides