codellm-devkit/mkdocs.yaml at main · ARiSE-Lab/codellm-devkit · 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
# Config for MkDocs
# To build:
# 1. Ensure you have MkDocs and friends: `pip install -e ".[docs]"`
# 2. `mkdocs serve` to view site locally with live refresh
# 3. `mkdocs build` to build the static site.
#    In the future, a GitHub action should do this.

site_name: CodeLLM-Devkit
repo_url: https://github.com/IBM/codellm-devkit
repo_name: IBM/codellm-devkit
# edit_uri: docs/
# site_url: https://ibm.github.io/cldk/

# This unusual configuration of docs/site directories
# is due to GitHub not presenting /site/ as an option
# when selecting the dir for Pages.
# docs_dir: docs
site_dir: _site

copyright: Copyright &copy; 2024 IBM

theme:
  name: material
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  icon:
    repo: fontawesome/brands/github
  features: # see https://squidfunk.github.io/mkdocs-material/setup/
    - search.highlight
    - search.suggest
    - navigation.sections
    - navigation.path
    - navigation.footer
    - navigation.indexes
    - navigation.top
    - toc.follow
    - toc.integrate
    - navigation.tabs
    - content.action.edit
  logo: assets/cldk.png
  palette:
    - primary: custom
nav:
  - Home: README.md
  - Walkthrough: walkthrough.md
  - API Reference: api_reference.md
  - Publications: publications.md
  - Contribute: contribute.md

# Define some IBM colors
extra_css:
  - stylesheets/extra.css

plugins:
- search
- mkdocstrings: # see https://mkdocstrings.github.io/python/usage/
    handlers:
      python:
        options:
          allow_inspection: true
          show_source: true
          show_bases: true
          show_symbol_type_toc: true
          show_submodules: false
          show_root_toc_entry: true
          docstring_section_style: table
          inherited_members: false
          summary: true
          docstring_style: google
          show_if_no_docstring: false
          show_labels: true
          heading_level: 3
          show_symbol_type_heading: true
          show_signature: true
          show_signature_annotations: true
          members_order: source

markdown_extensions:
  - admonition
  - toc:
      toc_depth: 3