bharat-courts/mkdocs.yml at main · edenbuilds/bharat-courts · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
site_name: bharat-courts
site_url: https://iamshouvikmitra.github.io/bharat-courts/
site_description: >-
  Plug India's entire judicial record into the AI you already use. bharat-courts
  is a free, open-source skill that lets Claude, ChatGPT and your own tools search
  cases, pull orders and read cause lists from official eCourts sources — locally,
  with no per-query API fees.
site_author: Shouvik Mitra
repo_name: iamshouvikmitra/bharat-courts
repo_url: https://github.com/iamshouvikmitra/bharat-courts
edit_uri: edit/main/docs/
copyright: >-
  bharat-courts is open-source under the MIT License. Court data is sourced from
  the official eCourts platform and the Indian Judgments AWS Open Data buckets
  (CC-BY-4.0, maintained by Dattam Labs).

theme:
  name: material
  custom_dir: overrides
  language: en
  logo: assets/logo.svg
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/iamshouvikmitra/bharat-courts
      name: bharat-courts on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/bharat-courts/
      name: bharat-courts on PyPI
  generator: false

plugins:
  - search
  - minify:
      minify_html: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            docstring_section_style: table
            filters: ["!^_"]

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      title: On this page
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - For Lawyers:
      - lawyers/index.md
      - What you can ask: lawyers/prompts.md
      - Set up in Claude Desktop: lawyers/claude-desktop.md
      - Set up in Claude Code & CoWork: lawyers/claude-code.md
      - Use with ChatGPT & other AI: lawyers/chatgpt-and-others.md
      - Questions & answers: lawyers/faq.md
  - Getting Started:
      - start/installation.md
      - Quickstart: start/quickstart.md
      - Configuration: start/configuration.md
  - Guides:
      - The Judgments facade: guides/facade.md
      - High Courts: guides/high-courts.md
      - District Courts: guides/district-courts.md
      - Calcutta High Court: guides/calcutta-hc.md
      - Judgment search: guides/judgment-search.md
      - Supreme Court: guides/supreme-court.md
      - Historical archive: guides/archive.md
      - CAPTCHA solving: guides/captcha.md
      - Command-line interface: guides/cli.md
  - API Reference:
      - reference/index.md
      - Judgments facade: reference/facade.md
      - Live clients: reference/clients.md
      - Archive client: reference/archive.md
      - Data models: reference/models.md
      - Courts registry: reference/courts.md
      - CAPTCHA solvers: reference/captcha.md
      - Configuration: reference/config.md
  - About:
      - How it works: about/how-it-works.md
      - Data & licensing: about/data-sources.md
      - Contributing: about/contributing.md