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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
site_name: PRIK
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
theme:
  name: readthedocs
  custom_dir: docs_theme
  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
plugins:
  - search
hooks:
  - tools/mkdocs_publication.py
markdown_extensions:
  - admonition
  - attr_list
  - toc:
      permalink: true
exclude_docs: |
  old_docs/**
nav:
  - Home: index.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
      - Performance: user/performance.md
      - Tutorials:
          - Overview: user/tutorials/index.md
          - Large Fortran Codebase: user/tutorials/large-fortran-codebase.md
          - Modern Fortran Project: user/tutorials/modern-fortran-project.md
          - Numerical Solver: user/tutorials/numerical-solver.md
          - Packaging: user/tutorials/packaging.md
          - Scientific Library: user/tutorials/scientific-library.md
      - Examples:
          - Overview: user/examples/index.md
          - BLAS Wrapper: user/examples/blas-wrapper.md
          - LAPACK Wrapper: user/examples/lapack-wrapper.md
          - CFD Mini Example: user/examples/cfd-mini-example.md
          - MPI Example: user/examples/mpi-example.md
          - Object-Oriented Fortran: user/examples/object-oriented-fortran.md
          - ODE Solver: user/examples/ode-solver.md
          - OpenMP Example: user/examples/openmp-example.md
          - Recipes:
              - Build and Import With the Python API: user/examples/recipes/build-and-import-python-api.md
              - Inspect a Fortran API: user/examples/recipes/inspect-fortran-api.md
              # PRIK_C_DOCS: - Inspect a C API: user/examples/recipes/inspect-c-api.md
              - Work With Semantic .pyi Contracts: user/examples/recipes/semantic-pyi-contracts.md
              - Control CLI Output: user/examples/recipes/control-cli-output.md
              - Use Python Inspection APIs: user/examples/recipes/use-python-inspection-apis.md
              - Use Compiler Preprocessing Options: user/examples/recipes/compiler-preprocessing.md
      - Troubleshooting:
          - Overview: user/troubleshooting/index.md
          - Installation Issues: user/troubleshooting/installation-issues.md
          - Compiler Issues: user/troubleshooting/compiler-issues.md
          - Build Issues: user/troubleshooting/build-issues.md
          - Runtime Issues: user/troubleshooting/runtime-issues.md
          - Platform-Specific Issues: user/troubleshooting/platform-specific-issues.md
      - FAQ: user/faq/index.md
      - Reference:
          - Overview: user/reference/index.md
          - CLI Commands: user/reference/cli-commands.md
          - Python API: user/reference/python-api.md
          - Fortran Wrapper Reference: user/reference/fortran-wrapper.md
          - Semantic IR: user/reference/semantic-ir.md
          - Semantic .pyi Format: user/reference/semantic-pyi-format.md
          - .pyi Contracts:
              - Overview: 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
          - Diagnostic Codes: user/reference/diagnostic-codes.md
          - Generated Functions: user/reference/generated-functions.md
          - Generated Modules: user/reference/generated-modules.md
          - Generated Classes: user/reference/generated-classes.md
          - Configuration Files: user/reference/configuration-files.md
      - Language Support:
          - Overview: user/language-support/index.md
          - Feature Matrix: user/language-support/feature-matrix.md
  - Developer Documentation:
      - Overview: developer/index.md
      - Development Workflow: developer/development-workflow.md
      - Source Map: developer/source-map.md
      - Feature To Code Map: developer/feature-to-code-map.md
      - Repository Structure: developer/repository-structure.md
      # PRIK_C_DOCS: - C Parser Reference: developer/c-parser-reference.md
      - Fortran Parser Reference: developer/fortran-parser-reference.md
      - Quality Assurance: developer/quality-assurance.md
      - Build System: developer/build-system.md
      - Testing Strategy: developer/testing-strategy.md
      - Coding Standards: developer/coding-standards.md
      - Adding A Feature: developer/adding-a-feature.md
      - Adding A Fortran Construct: developer/adding-a-fortran-construct.md
      - Adding A Code Generation Backend: developer/adding-a-code-generation-backend.md
      - Contributing:
          - Overview: developer/contributing/index.md
          - Contribution Guide: developer/contributing/contribution-guide.md
          - Pull Request Workflow: developer/contributing/pull-request-workflow.md
          - Review Process: developer/contributing/review-process.md
  - Maintainer Documentation:
      - Overview: maintainer/README.md
      - Documentation Architecture: maintainer/documentation-architecture.md
      - CI/CD: maintainer/ci-cd.md
      - Release Process: maintainer/release-process.md
      - Design:
          - Overview: maintainer/design/index.md
          - Overall Architecture: maintainer/design/overall-architecture.md
          - Parser Architecture: maintainer/design/parser-architecture.md
          - Semantic Analysis: maintainer/design/semantic-analysis.md
          - Runtime Model: maintainer/design/runtime-model.md
          - Error Propagation Model: maintainer/design/error-propagation-model.md
          - Memory Ownership Model: maintainer/design/memory-ownership-model.md
          - Code Generation: maintainer/design/code-generation.md
          - CPython Integration: maintainer/design/cpython-integration.md
          - Multilanguage Runtime Architecture: maintainer/design/semantic-multilanguage-wrapper-runtime-architecture.md
          - Wrapper Design Notes: maintainer/design/wrapper-design-notes.md
      - Internal Architecture:
          - Overview: maintainer/internal-architecture/index.md
          - Pipeline Map: maintainer/internal-architecture/pipeline-map.md
          - Wrapper Generation Pipeline: maintainer/internal-architecture/wrapper-generation-pipeline.md
          - AST Design: maintainer/internal-architecture/ast-design.md
          - Semantic Passes: maintainer/internal-architecture/semantic-passes.md
          - Type System: maintainer/internal-architecture/type-system.md
          - Runtime Layer: maintainer/internal-architecture/runtime-layer.md
          - Ownership Tracking: maintainer/internal-architecture/ownership-tracking.md
          - Dependency Analysis: maintainer/internal-architecture/dependency-analysis.md
          - Error Handling Pipeline: maintainer/internal-architecture/error-handling-pipeline.md
          - Symbol Tables: maintainer/internal-architecture/symbol-tables.md
      - Roadmaps:
          - Overview: maintainer/roadmap/index.md
          - Language-First Test Suite and Fortran Cleanup: maintainer/roadmap/fortran-test-suite-cleanup-checklist.md
          - Documentation Content: maintainer/roadmap/documentation-content-checklist.md
          - Semantic .pyi Wrapper: maintainer/roadmap/semantic-pyi-wrapper-checklist.md
          - Native Array Handles: maintainer/roadmap/native-array-handle-checklist.md
          - Wrapper Plan Migration: maintainer/roadmap/wrapper-plan-migration-checklist.md