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

ignore user-generated docs files #2479

Merged
merged 2 commits into from
Jul 8, 2024
Merged

Conversation

sebix
Copy link
Member

@sebix sebix commented Mar 17, 2024

and remove already committed files from the tree

@sebix sebix added the documentation Indicates a need for improvements or additions to documentation label Mar 17, 2024
@sebix sebix requested a review from gethvi March 17, 2024 20:26
@gethvi
Copy link
Contributor

gethvi commented Mar 19, 2024

Thanks!

There is one more step necessary: in the github action (build-docs.yaml) we need to generate these two files (by running scripts/generate-event-docs.py and scripts/generate-feeds-docs.py) before building the docs.

This will require ruamel.yaml installed.

@sebix
Copy link
Member Author

sebix commented Jun 27, 2024

There is one more step necessary: in the github action (build-docs.yaml) we need to generate these two files (by running scripts/generate-event-docs.py and scripts/generate-feeds-docs.py) before building the docs.

I expected that the docs build would fail if files were missing, but apparently, mkdocs does not complain about that. Thanks for noticing this, I added this step to the workflow file.

and remove already committed files from the tree
generate event and feed documentation before building the documentation
@sebix sebix merged commit e4c42bb into certtools:develop Jul 8, 2024
20 checks passed
@sebix sebix deleted the gitignore-docs branch July 8, 2024 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants