Skip to content

Document the parameter values in the docs - #50

Merged
brosaplanella merged 3 commits into
mainfrom
docs-parameter-values
Oct 31, 2026
Merged

brosaplanella merged 3 commits into
mainfrom
docs-parameter-values

Conversation

@brosaplanella

Copy link
Copy Markdown
Contributor

Closes #49.

A new documentation page, Parameter values, generated at each build from pytes.parameter_layers, so that it always matches the code.

What the page shows

  • Parameter sets: each named set in SETS, with a table linking to the layer of each kind it uses.
  • Layers: for each kind in LAYERS, its description, then for each layer:
    • its docstring, with the Source: and Taken at: lines rendered as fields;
    • the pytes.parameter_layers.get(...) call that returns it;
    • a table of parameter names and SI values, with °C next to absolute temperatures.

How

  • docs/parameter_values.py writes docs/parameter_values.rst. It is called from docs/conf.py, as the changelog and contributing pages are, and the output is gitignored.
  • The page is linked from the docs home page and its toctree.
  • New test test_material_layers_state_their_temperature: every fluid, PCM and metal layer must have a Taken at: line. The existing test_registered_layers_state_their_sources already checks the sources.

Notes

  • Three layers have "Taken at: not specified" (Hytherm 600 and the PCMs), and the page shows that as it is.
  • docs/index.md will conflict trivially with docs-model-pages (both add a toctree entry).
  • No change to DESIGN.md or findings.md: no decision or contract changes.

🤖 Generated with Claude Code

brosaplanella and others added 2 commits October 31, 2026 11:22
The page lists every named set and registered layer, with its values, its
source and, for the materials and fluids, the temperature at which the values
were taken. docs/conf.py writes it at each build from
pytes.parameter_layers, so it always matches the code. A new test requires a
"Taken at:" line in every fluid, PCM and metal layer.

Closes #49

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 PyTES | 🛠️ Build #35544109 | 📁 Comparing 33f2e83 against latest (5757c11)

  🔍 Preview build  

6 files changed · + 1 added · ± 5 modified

+ Added

± Modified

@brosaplanella
brosaplanella merged commit 9d0fa48 into main Oct 31, 2026
15 of 18 checks passed
@brosaplanella
brosaplanella deleted the docs-parameter-values branch October 31, 2026 13:15
@brosaplanella brosaplanella mentioned this pull request Nov 2, 2026
2 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the parameter values in the docs

1 participant