Skip to content

Remove some pdoc remnants#344

Merged
nrichers merged 2 commits intomainfrom
fix-pdoc-removal-error
Apr 1, 2025
Merged

Remove some pdoc remnants#344
nrichers merged 2 commits intomainfrom
fix-pdoc-removal-error

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Apr 1, 2025

Internal Notes for Reviewers

This PR:

  • Fixes a workflow issue related to the removal of the pdoc files
  • Removes CSS and HTML Jinja2 template for pdoc

Capto_ 2025-04-01_04-26-03_pm

External Release Notes

@nrichers nrichers added the internal Not to be externalized in the release notes label Apr 1, 2025
@nrichers nrichers requested a review from cachafla April 1, 2025 23:27
@CLAassistant
Copy link

CLAassistant commented Apr 1, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ cachafla
❌ nrichers
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2025

PR Summary

This pull request introduces two main changes:

  1. Enhancement to GitHub Actions Workflow:

    • The quarto-docs.yaml workflow file has been updated to include a token parameter for the actions/checkout@v4 step. This change uses the GH_TOKEN secret to authenticate the checkout process, which can help in accessing private repositories or increasing the API rate limit.
  2. Removal of Unused Documentation Templates:

    • The custom.css and module.html.jinja2 files have been removed from the docs/templates directory. These files were likely unused or redundant, and their removal helps in cleaning up the project structure.

These changes aim to improve the security and maintainability of the project by enhancing the CI/CD pipeline and removing unnecessary files.

Test Suggestions

  • Verify that the GitHub Actions workflow runs successfully with the new token configuration.
  • Check if the documentation generation process still works as expected without the removed templates.
  • Ensure that no other parts of the project depend on the removed custom.css and module.html.jinja2 files.

@nrichers nrichers merged commit cd1aec0 into main Apr 1, 2025
5 of 6 checks passed
@nrichers nrichers deleted the fix-pdoc-removal-error branch April 1, 2025 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants