Skip to content

Commit bed98e1

Browse files
Move internal APIs to Internal Details section
- Moved structural_transformation.md and bipartite_graph.md from API/ to internals/ - Created proper Internal Details section with overview and warnings - Added clear warnings that these are internal APIs not for public use - Updated pages.jl to reflect new documentation structure These functions are implementation details and should not be relied upon by users. Generated with Claude Code (https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent ad3cd80 commit bed98e1

File tree

4 files changed

+24
-5
lines changed

4 files changed

+24
-5
lines changed

docs/pages.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ pages = [
3232
"API/variables.md",
3333
"API/model_building.md",
3434
"API/problems.md",
35-
"API/structural_transformation.md",
36-
"API/bipartite_graph.md",
3735
"API/dynamic_opt.md",
3836
"API/codegen.md",
3937
"API/PDESystem.md"],
@@ -49,5 +47,8 @@ pages = [
4947
"basics/Precompilation.md",
5048
"basics/FAQ.md"],
5149
"comparison.md",
52-
"internals.md"
50+
"Internal Details" => Any[
51+
"internals.md",
52+
"internals/structural_transformation.md",
53+
"internals/bipartite_graph.md"]
5354
]

docs/src/internals.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
# Internal Details
22

3-
This is a page for detailing some of the inner workings to help future
4-
contributors to the library.
3+
This section documents the internal implementation details of ModelingToolkit. These APIs are not considered stable and may change without notice in non-breaking releases. They are documented here to help future contributors understand the library's inner workings.
4+
5+
## Overview
6+
7+
ModelingToolkit's internal architecture consists of several key components:
8+
9+
- **Structural Transformation**: Algorithms for transforming equation systems, including index reduction, tearing, and algebraic simplification
10+
- **Bipartite Graphs**: Graph representations used to analyze relationships between equations and variables
11+
- **System Structure**: Internal representations of system state and transformations
12+
13+
These components work together to enable ModelingToolkit's symbolic manipulation and code generation capabilities.
14+
15+
!!! warning
16+
The functions and types documented in this section are internal implementation details. Users should not rely on these APIs as they may change or be removed without deprecation warnings.

docs/src/API/bipartite_graph.md renamed to docs/src/internals/bipartite_graph.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Bipartite Graphs
22

3+
!!! warning "Internal API"
4+
The functions documented on this page are internal implementation details of ModelingToolkit. They are not part of the public API and may change or be removed without notice in non-breaking releases. This documentation is provided to help contributors understand the codebase.
5+
36
ModelingToolkit uses bipartite graphs to represent relationships between equations and variables in systems. These functions provide tools for working with and analyzing these graphs.
47

58
## Graph Types

docs/src/API/structural_transformation.md renamed to docs/src/internals/structural_transformation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Structural Transformation
22

3+
!!! warning "Internal API"
4+
The functions documented on this page are internal implementation details of ModelingToolkit. They are not part of the public API and may change or be removed without notice in non-breaking releases. This documentation is provided to help contributors understand the codebase.
5+
36
These functions are used for structural analysis and transformation of equation systems, including index reduction, tearing, and other algebraic manipulations used in the simplification process.
47

58
## Tearing and Algebraic Simplification

0 commit comments

Comments
 (0)