loman/mkdocs.yml at master · janushendersonassetallocation/loman · 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
site_name: Loman
site_description: Loman tracks state of computations, and the dependencies between them, allowing full and partial recalculations.
site_url: https://janushendersonassetallocation.github.io/loman
repo_url: https://github.com/janushendersonassetallocation/loman
repo_name: janushendersonassetallocation/loman

docs_dir: docs
site_dir: _book

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

extra:
  version:
    provider: mike

use_directory_urls: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            show_signature_annotations: true

markdown_extensions:
  - mkdocs_graphviz:
      node_color: "000000"
      node_fontcolor: "000000"
      edge_color: "000000"
      edge_fontcolor: "000000"
      graph_color: "000000"
      graph_fontcolor: "000000"
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: ["."]
  - admonition
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - Home: index.md
  - Quickstart: user/quickstart.md
  - User Guide:
      - Introduction: user/intro.md
      - Installation: user/install.md
      - Strategies: user/strategies.md
      - Features:
          - Creating:
              - Constant Values: user/features/creating/constant_values.md
              - Node Decorator: user/features/creating/adding_nodes_using_decorators.md
              - Named Tuples: user/features/creating/automatically_expanding_named_tuples.md
              - Computation Factories: user/features/creating/creating_computation_factories.md
              - Non-String Node Names: user/features/creating/non_string_node_names.md
              - Tagging Nodes: user/features/creating/tagging_nodes.md
          - Querying:
              - Show as DataFrame: user/features/querying/show_as_dataframe.md
              - View Inputs and Outputs: user/features/querying/view_inputs_outputs.md
              - Visualizing Graphs: user/features/querying/visualizing_computation_graph.md
          - Manipulating:
              - Repointing Nodes: user/features/manipulating/repointing_nodes.md
          - Other:
              - Interactive Debugging: user/features/other/interactive_debugging.md
              - Serializing Computations: user/features/other/serializing_computations.md
              - Migrating from write_dill: user/features/other/migrating_from_dill.md
  - Notebooks:
      - Overview: notebooks.md
      - CDOs: notebooks/cdos.html
      - Interest Rate Swaps: notebooks/interest_rate_swaps.html
      - Portfolio: notebooks/portfolio.html
      - Serialization: notebooks/serialization.html
      - Validation and Planning: notebooks/validation_and_planning.html
  - Reports:
      - Overview: reports.md
      - Test Report: reports/html-report/report.html
      - Coverage Report: reports/html-coverage/index.html
  - API Reference: api.md
  - Developer:
      - Release Checklist: dev/release.md
      - DevContainer: development/DEVCONTAINER.md
      - Marimo: development/MARIMO.md
      - Testing: development/TESTS.md
      - Contributing: CONTRIBUTING.md
      - Code of Conduct: CODE_OF_CONDUCT.md