Skip to content
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

regenerate docs #4406

Merged
merged 1 commit into from
Sep 21, 2024
Merged

regenerate docs #4406

merged 1 commit into from
Sep 21, 2024

Conversation

ajtmccarty
Copy link
Contributor

follow up to #4405

I think we just missed running inv docs.generate, so that is what this PR does

@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Sep 20, 2024
Copy link
Collaborator

@dgarros dgarros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to update the template instead to generate these docs with shell moving forward instead of console
As far as I understand that was @petercrocker 's goal in #4405

@petercrocker
Copy link
Contributor

I think we need to update the template instead to generate these docs with shell moving forward instead of console As far as I understand that was @petercrocker 's goal in #4405

Ok, I've done a bit more homework here. Docusaurus uses prism-react-render here for code blocks, and the most accurate label here is bash. That's the language label in our docusaurus config file:

additionalLanguages: ["bash", "python", "markup-templating", "django", "json", "toml", "yaml"],

So I'll add to this PR, changing inv docs.generate to use bash and change all references to bash, and mention this in our "docs development docs" 🙂

@dgarros
Copy link
Collaborator

dgarros commented Sep 21, 2024

Thanks @petercrocker, meanwhile I'm gonna merge this PR but right now because some PRs in stable are failing because of this

@dgarros dgarros merged commit 15e92ab into stable Sep 21, 2024
24 checks passed
@dgarros dgarros deleted the generate-docs-stable branch September 21, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants