Skip to content

Experiment: Auto-generated configuration reference #2743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

sh-rp
Copy link
Collaborator

@sh-rp sh-rp commented Jun 11, 2025

Description

This PR is an experiment to generate a docs page from our config specs to see wether this is viable / useful. This is still very hacky code and will be cleaned up a bit into a proper tool if we want to do this. We use ast to get the docstrings and the already existing configspec mechanism to collect all configspecs.

Notes:

  • Right now the script only renders destination and credentials configurations in their own groups, the rest gets dumped at the bottom, also there are some Baseclasses we probably do not want to render in the final version
  • This script should also enforce a docstring for every config class as well as a docstring for every property. If there is a docstring on a property of the same name in any class in the inheritance hierarchy, this one will be taken and it should pass (this is implemented already)
  • This page should be checked into the repo and not generated on the fly, much like the cli docs. We also need a script for ci to verify that it is up to date.

@sh-rp sh-rp added the QoL Quality of Life label Jun 11, 2025
Copy link

netlify bot commented Jun 11, 2025

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 3b7458d
🔍 Latest deploy log https://app.netlify.com/projects/dlt-hub-docs/deploys/6849804632b0c80008225040
😎 Deploy Preview https://deploy-preview-2743--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@sh-rp sh-rp force-pushed the exp/config_reference branch from db13875 to 3b7458d Compare June 11, 2025 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
QoL Quality of Life
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically generate docs pages for all possible config values and cli commands
1 participant