Skip to content

docs: settings documentation using settings-doc markdown generator#698

Merged
fstagni merged 3 commits intoDIRACGrid:mainfrom
ryuwd:document-settings
Jan 22, 2026
Merged

docs: settings documentation using settings-doc markdown generator#698
fstagni merged 3 commits intoDIRACGrid:mainfrom
ryuwd:document-settings

Conversation

@ryuwd
Copy link
Contributor

@ryuwd ryuwd commented Nov 4, 2025

Add pixi task:

  • generate-settings-doc: Generate settings documentation in Markdown format

Adds also a pre-commit hook to automatically generate settings docs

relates to #664 #248

@read-the-docs-community
Copy link

read-the-docs-community bot commented Nov 4, 2025

Documentation build overview

📚 diracx | 🛠️ Build #31104417 | 📁 Comparing 9881214 against latest (26c86fa)


🔍 Preview build

Show files changed (3 files in total): 📝 3 modified | ➕ 0 added | ➖ 0 deleted
File Status
admin/reference/env-variables/index.html 📝 modified
dev/reference/env-variables/index.html 📝 modified
dev/reference/pixi-tasks/index.html 📝 modified

ryuwd added 3 commits January 22, 2026 13:50
fix: annoying wrapper script

docs: fix task doc

fix: add ci skip settings-doc-check
fix: well that didn't work

fix: update tasks

fix: format settings doc files
@ryuwd ryuwd force-pushed the document-settings branch from 228865b to 9881214 Compare January 22, 2026 12:50
@ryuwd
Copy link
Contributor Author

ryuwd commented Jan 22, 2026

Rebased!

@fstagni fstagni merged commit ccb1f48 into DIRACGrid:main Jan 22, 2026
27 checks passed
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.

2 participants