quicopt-python/mkdocs.yml at main · Quicopt/quicopt-python · 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
site_name: quicopt
site_description: Python client for the Quicopt optimization service — write a model in Pyomo, MathOpt or PuLP and solve it.
site_url: https://quicopt.github.io/quicopt-python/
repo_url: https://github.com/Quicopt/quicopt-python
repo_name: Quicopt/quicopt-python
copyright: Copyright &copy; 2026 Tim Bode, PGI-12, Forschungszentrum Jülich

theme:
  name: material
  font: false                      # system font stack — no Google Fonts CDN call
  logo: assets/quicopt-icon-color.svg      # header logo; extra.css swaps to white in dark mode
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - content.code.copy
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom        # exact brand hex lives in docs/stylesheets/extra.css
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: table
            show_root_heading: true
            show_root_full_path: false
            show_source: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            # Render the public surface only. The private helpers are documented in
            # the source for maintainers; to surface them here, drop this filter.
            filters: ["!^_"]

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite

nav:
  - Home: index.md
  - API reference:
      - ir — intermediate representation: api/ir.md
      - wire — the encoder: api/wire.md
      - pyomo — read a Pyomo model: api/pyomo.md
      - stochastic — models under uncertainty: api/stochastic.md
      - mathopt — read a MathOpt model: api/mathopt.md
      - pulp — read a PuLP model: api/pulp.md
      - client — send it, read the result: api/client.md