Fix doc generation #389
Merged
Fix doc generation #389
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
juanpcapurro
force-pushed
the
fix-doc-generation
branch
2 times, most recently
from
93996d2
to
e2dc7ac
Compare
|
@juanpcapurro |
passing a string instead of the bare option was breaking the script responsible for generating the docs
- update generated docs - run the doc generation on CI so we don't break it again - ensure the changes to the docs were commited to source control
juanpcapurro
force-pushed
the
fix-doc-generation
branch
from
e2dc7ac
to
8b9ee5f
Compare
dbale-altoros
approved these changes
Jan 27, 2023
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.
while creating a new rule I found that the script responsible for generating the documentation was broken (well, not the script itself, but the metadata supplied to it) I fixed it and added a CI step to ensure that at least it doesn't crash.
I tried to get CI to also check that the latest version of the docs are commited to source control (with
git diff docs --exit-code) but versions for files were different between CI and my machine. So it's out of scope for this PR 🙃 but I can create an issue to implement that later if there's consensus