pyQUESTPlus/mkdocs.yml at main · BrainardLab/pyQUESTPlus · 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
site_name: ccn-template
repo_url: https://github.com/flatironinstitute/ccn-template

theme:
  name: 'material'
  palette:
    primary: 'light blue'
    features:
      - navigation.tabs
plugins:
    - search                           # make sure the search plugin is enabled
    - mkdocstrings:                    # plugin for generating documentation from Python docstrings
        handlers:                      # handler is responsible for loading and parsing source files
          python:                      # set handler is for Python
            options:                   # configuration of options for the Python handler
              docstring_style: numpy   # style of docstrings (convention followed)
              show_source: true        # include a link to the source code
              show_members: source     # configures the order in which members (methods, attributes, etc.) are displayed.
                                       # If set to 'source', it means the order in the source code will be maintained.
    - gen-files:
        scripts:
            - docs/gen_ref_pages.py     # script for generating reference pages
    - literate-nav:
          nav_file: docs/SUMMARY.md     # navigation file for literate navigation
    - section-index                    # plugin for creating section index
    - gallery:
        examples_dirs: docs/examples          # path to your example scripts
        gallery_dirs: docs/generated/gallery  # where to save generated gallery
nav:
    - Home: index.md
    - Tutorials: generated/gallery
    - Workflow: notes/00-workflow.md
    - Structure: notes/01-structure.md
    - Packaging: notes/02-packaging.md
    - Documentation: notes/03-documentation.md
    - Docstrings: notes/04-docstrings.md
    - Linters and Tests: notes/05-linters-and-tests.md
    - CI: notes/06-ci.md
    - Data: notes/07-data.md
    - Open Source: notes/08-open-source.md
    - Code References: reference/
    - About: about.md