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

Upgrade and pin Vale to v3 #31

Merged
merged 12 commits into from
Oct 6, 2024
Merged

Upgrade and pin Vale to v3 #31

merged 12 commits into from
Oct 6, 2024

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Oct 5, 2024

  • Follow some of Vale's suggestions and fix errors and warnings.
  • Add GitHub Workflow to build docs and run checks on links, spelling, grammar, and style.
  • Closes Pin requirements #30.

📚 Documentation preview 📚: https://plone-sphinx-theme--31.org.readthedocs.build/

@stevepiercy
Copy link
Contributor Author

@davisagli I was today days old when I learned that pyproject.toml should list your packages, but not pins of packages, and let that stay in requirements-docs.txt.

This PR should handle the downstream issues that may arise from documentation. I also just realized that eventually any project that uses this theme could have a simplified requirements-docs.txt file that contains only plone-sphinx-theme==x.x.x.

Thanks for the nudge to pin packages. I never fully understood the benefits.

@davisagli
Copy link
Member

@stevepiercy Btw, there are tools that can take a list of unpinned packages and generate a requirements.txt with the current latest pins.

I used to use pip-tools for this: https://hynek.me/til/pip-tools-and-pyproject-toml/

But now I would use uv, because it's faster and can correctly handle cases where the dependencies are resolved differently on different platforms. https://docs.astral.sh/uv/pip/compile/

news/31.feature Show resolved Hide resolved
requirements-docs.txt Outdated Show resolved Hide resolved
@stevepiercy
Copy link
Contributor Author

But now I would use uv, because it's faster and can correctly handle cases where the dependencies are resolved differently on different platforms. https://docs.astral.sh/uv/pip/compile/

Challenge accepted! I realize the deps could be better organized into 3 different buckets: install, develop, and release. Right now they're not well separated.

@stevepiercy
Copy link
Contributor Author

Merging, and moving on to improving dep management with uv.

@stevepiercy stevepiercy merged commit 66d3258 into main Oct 6, 2024
2 checks passed
@stevepiercy stevepiercy deleted the vale-enhance branch October 6, 2024 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Pin requirements
2 participants