pdfrest-python/mkdocs.yml at main · pdfrest/pdfrest-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
site_name: pdfrest
site_description: Python client library for interacting with the pdfRest API
repo_url: https://github.com/pdfrest/pdfrest-python
docs_dir: docs
site_dir: site
strict: true

theme:
  name: material
  custom_dir: overrides
  logo: assets/pdfrest-logo-dark-bg.png
  favicon: assets/favicon.ico
  palette:
    scheme: default
    primary: custom
    accent: custom
  features:
    - content.code.copy

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            heading_level: 2
            line_length: 50
            members_order: alphabetical
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            show_source: false
            show_root_heading: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences

extra_css:
  - assets/stylesheets/brand.css

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Client Configuration: client-configuration.md
  - Using Files: using-files.md
  - API Guide: api-guide.md
  - API Reference: api-reference.md