PyCompTox/mkdocs.yml at main · USEtox/PyCompTox · 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
site_name: PyCompTox Documentation
site_description: Python interface to the EPA CompTox Dashboard Chemical API
site_author: PyCompTox Contributors
site_url: https://usetox.github.io/PyCompTox/

repo_name: USEtox/PyCompTox
repo_url: https://github.com/USEtox/PyCompTox
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: INSTALLATION.md
    - Quick Start: quick_start.md
    - Quick Reference: QUICK_REFERENCE.md
    - Configuration: configuration.md
    - Category Organization: CATEGORY_ORGANIZATION.md
    - Caching System: CACHING.md
  - User Guide:
    - Setup & Configuration: MODERN_SETUP.md
    - API Key & Rate Limiting: API_KEY_AND_RATE_LIMITING.md
    - Batch Methods: BATCH_METHODS.md
    - Best Practices: best_practices.md
    - Examples: examples.md
  - Chemical Module:
    - Chemical Search: CHEMICAL_SEARCH.md
    - Chemical Details: CHEMICAL_DETAILS.md
    - Chemical Properties: CHEMICAL_PROPERTIES.md
    - Chemical Synonyms: CHEMICAL_SYNONYMS.md
    - Wikipedia Links: WIKIPEDIA_LINKS.md
    - PubChem Links: PUBCHEM_LINKS.md
    - Extra Data: EXTRA_DATA.md
  - Bioactivity Module:
    - Bioactivity Data & AOP: BIOACTIVITY_DATA.md
  - Exposure Module:
    - Exposure Predictions: EXPOSURE_PREDICTIONS.md
  - Hazard Module:
    - Hazard Overview: HAZARD_MODULE.md
  - Additional Data:
    - CCC Data: CCC_DATA.md
    - MMDB Data: MMDB_DATA.md
    - Functional Use: FUNCTIONAL_USE.md
    - Product Data: PRODUCT_DATA.md
    - HTTK Data: HTTK_DATA.md
    - List Presence: LIST_PRESENCE.md
  - API Documentation:
    - Configuration: api/config.md
    - Cache: api/cache.md
    - Chemical: api/chemical.md
    - ChemicalDetails: api/details.md
    - ChemicalProperties: api/properties.md
    - ChemSynonym: api/chemsynonym.md
    - BioactivityData: api/bioactivitydata.md
    - BioactivityAOP: api/bioactivityaop.md
    - ExtraData: api/extradata.md
    - WikiLink: api/wikilink.md
    - PubChemLink: api/pubchemlink.md
    - CCCData: api/cccdata.md
    - MMDB: api/mmdb.md
    - FunctionalUse: api/functionaluse.md
    - ProductData: api/productdata.md
    - HTTKData: api/httkdata.md
    - ListPresence: api/listpresence.md
    - ExposurePrediction: api/exposureprediction.md
    - DemographicExposure: api/demographicexposure.md
    - Hazard Module:
      - PPRTV: api/pprtv.md
      - ToxValDBCancer: api/toxvaldbcancer.md
      - ToxRefDBEffects: api/toxrefdbeffects.md
      - ToxRefDBSummary: api/toxrefdbsummary.md
      - ToxRefDBBatch: api/toxrefdbbatch.md
      - ToxValDBSkinEye: api/toxvaldbskineye.md
      - ToxValDB: api/toxvaldb.md
      - HAWC: api/hawc.md
      - IRIS: api/iris.md
      - ToxValDBGenetox: api/toxvaldbgenetox.md
      - ToxRefDBData: api/toxrefdbdata.md
      - ADMEIVIVE: api/admeivive.md
      - ToxRefDBObservation: api/toxrefdbobservation.md
  - About:
    - Contributing: contributing.md
    - License: license.md
    - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/USEtox/PyCompTox
  version:
    provider: mike

copyright: Copyright &copy; 2025 PyCompTox Contributors