Skip to content

Docs/missing flex config fields#2003

Merged
Flix6x merged 11 commits intomainfrom
docs/missing-flex-config-fields
Mar 5, 2026
Merged

Docs/missing flex config fields#2003
Flix6x merged 11 commits intomainfrom
docs/missing-flex-config-fields

Conversation

@Flix6x
Copy link
Contributor

@Flix6x Flix6x commented Mar 5, 2026

Description

  • Add missing field descriptions for aggregate-power
  • Add missing field descriptions for state-of-charge
  • Add missing field descriptions for commitments (although not fully specified, I think it is already useful to mention it exists)
  • Purposely exclude relax-capacity-constraints, relax-site-capacity-constraints and relax-soc-constraints (we already document relax-constraints and the ability to set individual prices, and I don't want to overload users with information).
  • Add a test to make sure all flex-config fields are present in scheduling.rst
  • Added changelog item in documentation/changelog.rst

Look & Feel

image

How to test

pytest -k pytest -k test_all_metadata_fields_are_documented

Further Improvements

None

Related Items

Closes #2002

Flix6x added 4 commits March 5, 2026 09:38
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x Flix6x self-assigned this Mar 5, 2026
@read-the-docs-community
Copy link

read-the-docs-community bot commented Mar 5, 2026

Documentation build overview

📚 flexmeasures | 🛠️ Build #31678460 | 📁 Comparing 85e29b4 against latest (b1a7022)


🔍 Preview build

Show files changed (5 files in total): 📝 5 modified | ➕ 0 added | ➖ 0 deleted
File Status
changelog.html 📝 modified
_autodoc/COMMITMENTS.html 📝 modified
_autosummary/flexmeasures.utils.doc_utils.html 📝 modified
api/v3_0.html 📝 modified
features/scheduling.html 📝 modified

Flix6x added 4 commits March 5, 2026 09:59
…eduling.rst

Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x Flix6x added documentation Improvements or additions to documentation Scheduling labels Mar 5, 2026
@Flix6x Flix6x added this to the 0.31.1 milestone Mar 5, 2026
@Flix6x Flix6x requested a review from nhoening March 5, 2026 09:10
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, with one extra wish:

Under the commitments (not mentioned in the PR description?), it says "Support for this field in the UI is still under further development, but you can study the code to learn more.". Much better would be to link that to our new documentation page for commitments.

Flix6x added 2 commits March 5, 2026 15:26
Signed-off-by: F.N. Claessen <claessen@seita.nl>
…(the Sphinx anchor mapping is not really working yet for Swagger)

Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
Copy link
Contributor Author

Flix6x commented Mar 5, 2026

Better, but not easier.. 😄

@Flix6x Flix6x merged commit 07e42d3 into main Mar 5, 2026
6 of 7 checks passed
@Flix6x Flix6x deleted the docs/missing-flex-config-fields branch March 5, 2026 14:47
Flix6x added a commit that referenced this pull request Mar 6, 2026
* fix: add missing soc-at-start field docs

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* fix: add missing aggregate-power field docs

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: changelog entry

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* fix: missing aggregate-power field description in Swagger

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* feat: add test to verify all flex-config fields are documented in scheduling.rst

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* fix: just a few fields are intentionally excluded from the documentation

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* fix: add missing commitments field docs

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* style: black

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* chore: advance fix from v0.32.0 to v0.31.1

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* feat: cross-reference the section explaining commitments

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* feat: still link Swagger to Sphinx, but use the search functionality (the Sphinx anchor mapping is not really working yet for Swagger)

Signed-off-by: F.N. Claessen <claessen@seita.nl>

---------

Signed-off-by: F.N. Claessen <claessen@seita.nl>

(cherry picked from commit 07e42d3)
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Scheduling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing flex-config fields in documentation

2 participants