Skip to content

sphinx-config-schema 0.0.2

Choose a tag to compare

@github-actions github-actions released this 03 Nov 12:24
· 4 commits to main since this release
Immutable release. Only release title and notes can be modified.
207ab13

✨ New features

  • Configuration keys rendered by config-schema are Sphinx labels that ref can link to (#11)
  • New config-schema:option role links to a key and renders it as inline code (#17)
  • Registers cfg as a short alias of the config-schema:option role (#23)

⚠️ Enhancements and optimizations

  • Optional enum settings without a default show their first choice as an example (#7)
  • Option references with a leading . resolve by key suffix, and ~ shortens the title (#23)
  • Free-form tables without properties render as an empty table instead of disappearing (#29)
  • Required keys are marked with an asterisk in the example and a badge in the tooltip (#32)

⚠️ API changes

  • Option labels separate key levels with dots, as in settings.output instead of settings-output (#13)

⚠️ Changes that may affect behavior

  • Anchors of unnamed examples end with the format, so old #…-output links no longer jump to the key (#11)
  • References with a leading . match by key suffix instead of as exact labels (#23)

🐛 Bug fixes

  • Enum choices resolve through local $ref and anyOf or oneOf alternatives (#7)
  • A null default no longer renders an inferred example as if it were the default (#10)
  • Examples in LaTeX and PDF output get syntax highlighting, a frame, and a caption (#15)
  • Nullable non-enum fields no longer list null as their only allowed value (#34)

📝 Documentation

  • Landing page shows PyPI, Python version, CI, and license badges (#5)
  • Documents enum choices as the final fallback for generated examples (#7)
  • New "Referencing options" section shows the reference syntax in MyST and reST (#11)
  • Documentation is also available as a PDF (#15)
  • API pages reflect the split into schema, render, codeblock, and tooltips submodules (#24)

🔨 Maintenance

  • Helpers such as render() and iter_settings() move into dedicated submodules (#24)

🖱️ Developer Experience

  • Test coverage is reported to Codecov and must stay above 95% (#22)
  • Tests are organized per module as nested pytest-describe behavior specifications (#24)

The full changelog as commits can be found here.