cvae/mkdocs.yaml at main · FaSalih/cvae · 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
# generate HTML docs from Python's source code files.
site_name: cvae
site_author: Santiago Miranda
site_description: Documentation for the Chemical Variational Autoencoder
site_url: https://ghsanti.github.io/cvae/
repo_url: https://github.com/ghsanti/cvae
repo_name: cvae

docs_dir: docs # reads .md from
site_dir: site # write .html to

hooks: # script to transform project/**.py => docs/*.md files
  - make_doc_files.py

plugins:
  - search # search functionality.
  # mkdocs-plugin: extracts docstrs from .py files.
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options: # config may need changes
            show_symbol_type_toc: true
            show_symbol_type_heading: true
            show_category_heading: true
            show_docstring_examples: true
            show_signature_annotations: true

            group_by_category: true
            annotations_path: brief
            unwrap_annotated: true
            merge_init_into_class: true
            docstring_style: numpy

            summary: true

# overall layout & look of the page
theme:
  name: readthedocs
  highlightjs: true
  hljs_languages:
    - python
  color-mode: auto
  user_color_mode_toggle: true
  titles_only: true
  exclude_docs: |
    test_*.py
    __init__.py
  include_homepage_in_sidebar: false
  markdown_extensions:
    - smarty
    - toc:
      permalink: true
      separator: "_"
    - sane_lists

watch:
  - chemvae