Skip to content

Commit 25a0751

Browse files
Copilotclaude
andauthored
Restructure API reference and align docs checks with public API (#1620)
* Initial plan * Restructure API reference documentation Co-Authored-By: Claude Code (claude-sonnet-4-6) <noreply@anthropic.com> * Adjust Documenter missing-docs check --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Claude Code (claude-sonnet-4-6) <noreply@anthropic.com>
1 parent f0af90c commit 25a0751

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ const contributing = [
2626

2727
makedocs(;
2828
modules = [TulipaEnergyModel],
29+
checkdocs = :exports,
2930
authors = "Abel Soares Siqueira <abel.s.siqueira@gmail.com>,Diego A. Tejada-Arango <diego.tejadaarango@tno.nl>,Germán Morales-España <german.morales@tno.nl>,Grigory Neustroev <G.Neustroev@tudelft.nl>,Juha Kiviluoma <Juha.Kiviluoma@vtt.fi>,Lauren Clisby <lauren.clisby@tno.nl>,Maaike Elgersma <m.b.elgersma@tudelft.nl>,Ni Wang <ni.wang@tno.nl>,Suvayu Ali <s.ali@esciencecenter.nl>,Zhi Gao <z.gao1@uu.nl>",
3031
sitename = "TulipaEnergyModel.jl",
3132
format = Documenter.HTML(; canonical = "https://TulipaEnergy.github.io/TulipaEnergyModel.jl"),

docs/src/70-reference.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44
Pages = ["70-reference.md"]
55
```
66

7+
## Public API
8+
9+
The functions and types below form the supported public interface of
10+
TulipaEnergyModel.jl.
11+
712
```@autodocs
813
Modules = [TulipaEnergyModel]
14+
Private = false
915
```
16+
17+
## Internal implementation details
18+
19+
Internal helper functions (such as names starting with `_`) are not part of
20+
the public API and are intentionally omitted from this page.

0 commit comments

Comments
 (0)