prik/mkdocs.yml at main · PyNumLab/prik · 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
site_name: PRIK — Bring Native Code to Python
site_description: PRIK generates native Python bindings for Fortran and C code.
site_url: https://pynumlab.github.io/prik/
repo_url: https://github.com/PyNumLab/prik
repo_name: GitHub
edit_uri: blob/main/docs/
docs_dir: docs
site_dir: .artifacts/site
theme:
  name: readthedocs
  custom_dir: docs_theme
  logo: user/assets/prik-mark.png
  collapse_navigation: false
  include_homepage_in_sidebar: true
  navigation_depth: 4
  sticky_navigation: true
  titles_only: false
extra_css:
  - stylesheets/site.css
  - stylesheets/code-copy.css
extra_javascript:
  - javascripts/code-copy.js
  - javascripts/example-tabs.js
  - javascripts/faq.js
  - javascripts/term-tooltips.js
plugins:
  - search
hooks:
  - tools/mkdocs_publication.py
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
nav:
  - Home: index.md
  - About: user/about.md
  - User Documentation:
      - Overview: user/index.md
      - Getting Started:
          - Overview: user/getting-started/index.md
          - Installation: user/getting-started/installation.md
          - Verification: user/getting-started/verification.md
          - First Wrapped Function: user/getting-started/first-wrapped-function.md
          - First Wrapped Module: user/getting-started/first-wrapped-module.md
          - Common Beginner Workflow: user/getting-started/beginner-workflow.md
      - User Guide:
          - Overview: user/guide/index.md
          - Data Types: user/guide/data-types.md
          - Arrays: user/guide/arrays.md
          - Strings: user/guide/strings.md
          - Wrapping Functions: user/guide/wrapping-functions.md
          - Wrapping Subroutines: user/guide/wrapping-subroutines.md
          - Wrapping Modules: user/guide/wrapping-modules.md
          - Optional Arguments: user/guide/optional-arguments.md
          - Generic Interfaces (Overloading): user/guide/generic-interfaces.md
          - Wrapping Derived Types: user/guide/wrapping-derived-types.md
          - Allocatables: user/guide/allocatables.md
          - Pointers: user/guide/pointers.md
          - Memory Management: user/guide/memory-management.md
          - Callbacks: user/guide/callbacks.md
          - Enumerations: user/guide/enumerations.md
          - Raw Addresses: user/guide/raw-addresses.md
          - Error Handling & Diagnostics: user/guide/error-handling.md
          - Building the Shared Library: user/guide/building-shared-library.md
      - Examples:
          - Overview: user/examples/index.md
          - Fortran:
              - BLAS Wrapper: user/examples/fortran/blas-wrapper.md
              - LAPACK Wrapper: user/examples/fortran/lapack-wrapper.md
              - FFTPACK Wrapper: user/examples/fortran/fftpack-wrapper.md
              - MINPACK Wrapper: user/examples/fortran/minpack-wrapper.md
              - BSPLINE-FORTRAN Wrapper: user/examples/fortran/bspline-wrapper.md
          - C:
              - libm Wrapper: user/examples/c/libm-wrapper.md
              - TA-Lib Wrapper: user/examples/c/ta-lib-wrapper.md
      - Performance: user/performance.md
      - Language Support:
          - Overview: user/language-support/index.md
          - Fortran: user/language-support/fortran-support.md
          - C: user/language-support/c-support.md
          - Feature Matrix: user/language-support/feature-matrix.md
      - Troubleshooting:
          - Compiler Issues: user/troubleshooting/compiler-issues.md
      - FAQ: user/faq/index.md
      - Reference:
          - Overview: user/reference/index.md
          - Drive PRIK:
              - CLI Commands: user/reference/cli-commands.md
              - Python API: user/reference/python-api.md
              - Build Manifests and Makefiles: user/reference/configuration-files.md
          - Contracts:
              - .pyi Format: user/reference/pyi-format.md
              - Editing Contracts: user/reference/pyi-contracts/index.md
              - Exports and Modules: user/reference/pyi-contracts/exports-and-modules.md
              - Functions and Classes: user/reference/pyi-contracts/functions-and-classes.md
              - Calls and Results: user/reference/pyi-contracts/calls-and-results.md
          - Diagnostics:
              - Diagnostic Codes: user/reference/diagnostic-codes.md
  - Developer Documentation:
      - Overview: developer/index.md
      - Architecture: developer/architecture.md
      - Architecture Components:
          - Overview: developer/packages/index.md
          - Pipeline: developer/packages/pipeline.md
          - Preprocessing: developer/packages/preprocessing.md
          - Parsers: developer/packages/parsers.md
          - Semantics: developer/packages/semantics.md
          - Policy: developer/packages/policy.md
          - Planning: developer/packages/planning.md
          - Code Generation:
              - Overview: developer/packages/codegen.md
              - C Binding: developer/packages/codegen/c-binding.md
              - Fortran Bridge: developer/packages/codegen/fortran-bridge.md
          - Printers: developer/packages/printers.md
          - Compiler: developer/packages/compiler.md
          - Contracts: developer/packages/contracts.md
          - Naming: developer/packages/naming.md
          - Runtime: developer/packages/runtime.md
          - Utilities: developer/packages/utilities.md
      - Codebase Map: developer/codebase-map.md
      - Feature-to-Code Map: developer/feature-to-code-map.md
      - Testing Strategy: developer/testing-strategy.md
      - Workflows:
          - Contributing: developer/workflows/contributing.md
          - Quality Assurance: developer/workflows/quality-assurance.md
          - Pull Request Checks: developer/workflows/ci.md
          - Documentation Maintenance: developer/workflows/documentation.md