acopula/mkdocs.yml at main · thisiscam/acopula · 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
site_name: acopula
site_description: Archimedean copula inference via Taylor-mode automatic differentiation in JAX
site_url: https://thisiscam.github.io/acopula/
repo_url: https://github.com/thisiscam/acopula
repo_name: thisiscam/acopula
docs_dir: docs

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Examples:
      - Two-level copula: examples/01_quickstart.ipynb
      - Fitting by MLE: examples/02_fit_mle.ipynb
      - Censored survival: examples/03_censored_survival.ipynb
      - Sampling & visualization: examples/04_sampling_and_visualize.ipynb
      - Neural generator (ACNet): examples/05_neural_acnet.ipynb
  - API reference: api.md

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.arithmatex:      # $...$ / $$...$$ rendered by MathJax
      generic: true
  - toc:
      permalink: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  # Render committed .ipynb notebooks (execute=false: use their stored outputs).
  - mkdocs-jupyter:
      execute: false
      include_source: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: table     # Args/Returns as tables
            show_root_heading: true
            show_root_full_path: false         # "Copula", not "acopula.core.Copula"
            show_symbol_type_heading: true      # class/func/attr badges
            show_symbol_type_toc: true          # and in the nav TOC
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: false   # CompiledModel isn't user-constructed; its __init__ leaks private fields
            members_order: source
            filters: ["!^_"]                    # hide private / dunder members
            show_source: false
            summary: true
            heading_level: 3   # section headers are ## (h2); symbols nest as h3
  # Emits /llms.txt (an index for LLMs/agents, per llmstxt.org) plus a single
  # concatenated llms-full.txt of the whole site.
  - llmstxt:
      markdown_description: >
        acopula fits nested Archimedean copulas end-to-end with jax.grad,
        including high-dimensional models and per-dimension censoring, using
        Taylor-mode automatic differentiation for the high-order derivatives.
      full_output: llms-full.txt
      sections:
        Usage:
          - index.md
          - quickstart.md
        API:
          - api.md