📝 [open-zaak/open-zaak#1649] Document envvars #206
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #206 +/- ##
=======================================
Coverage 96.79% 96.79%
=======================================
Files 143 143
Lines 6272 6272
=======================================
Hits 6071 6071
Misses 201 201 ☔ View full report in Codecov by Sentry. |
stevenbal
force-pushed
the
feature/envvar-documentation
branch
from
cefabbf
to
a5fb7d8
Compare
stevenbal
changed the title
5 tasks
stevenbal
commented
Jul 23, 2024
stevenbal
force-pushed
the
feature/envvar-documentation
branch
2 times, most recently
from
af6279b
to
9e12992
Compare
annashamray
requested changes
Jul 29, 2024
.github/workflows/ci.yml
Outdated
| run: pip install -r requirements/ci.txt pytest | ||
| - name: Generate environment variable documentation using OAf and check if it was updated | ||
| run: | | ||
| python src/manage.py generate_envvar_docs --file docs/installation/config.rst --exclude-group Celery |
There was a problem hiding this comment.
Let's have a bash file with it, it can be useful for generating docs
Too bad it seems impossible to add it as sphinx event
stevenbal
force-pushed
the
feature/envvar-documentation
branch
from
9e12992
to
f7fa322
Compare
replace the manual envvar docs with OAf `generate_envvar_docs`, this ensure that generic envvars that are used by every component are documented centrally in OAF and custom envvars can be documented in the code where they are declared
stevenbal
force-pushed
the
feature/envvar-documentation
branch
from
f7fa322
to
5ed27fe
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes open-zaak/open-zaak#1649 partially
Changes