✨ [open-zaak/open-zaak#1649] Command to document envvars

[stevenbal]

Closes open-zaak/open-zaak#1649 partly

TODO:

• add tests
• add separate flag to mark as required vs required in docker?
• move intro text to library, only override in Objects?

[stevenbal]

@annashamray let me know if this approach is something that you think is worthwhile, I think it could save us a lot of hassle when it comes to documenting envvars (especially those that are used by every project). Here is an example of what it looks like after running the command: https://github.com/maykinmedia/objecttypes-api/blob/66a942d613776cb1766d3da025ce5e321103cf40/docs/env_config.rst

[annashamray]

I quite like it! It also forces you to write what the env variable actually does, which is a good thing for me.
Do you think that generating docks for djang-setup-configuration would be redundant in this case?

[stevenbal]

Do you think that generating docks for djang-setup-configuration would be redundant in this case?

I'm not sure, since there already were docs for those I excluded them, also because they maybe require a bit more explanation to describe the ConfigurationSteps as a whole. Also the generated docs for setup-configuration relies on reusing the model field help_texts, so I think that's still good to have

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 95.45455% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.35%. Comparing base (d9a4a86) to head (ac6e174).
Report is 22 commits behind head on main.

Files	Patch %	Lines
open_api_framework/conf/utils.py	95.45%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #22      +/-   ##
==========================================
+ Coverage   76.00%   82.35%   +6.35%     
==========================================
  Files           4        4              
  Lines          50       68      +18     
==========================================
+ Hits           38       56      +18     
  Misses         12       12              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[stevenbal]

@annashamray this PR is now ready for review :)

[annashamray]

Looks good!

It would be nice to have tests for the command (and perhaps config util but it's optional)
testapp/settings.py seems like a perfect place to add a couple of settings with env vars

[annashamray]

👍