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

Feature Request: A one command solution to locally building packaged crates with the same environment as docs.rs #2721

Open
nhtyy opened this issue Jan 13, 2025 · 1 comment

Comments

@nhtyy
Copy link

nhtyy commented Jan 13, 2025

  • Docs rs is nowhere near as simple as just cargo doc --release
  • Its non trivial to reproduce building docs locally
@syphar
Copy link
Member

syphar commented Jan 14, 2025

Could you relaborate what's missing for you? I'm aware that the situation could be better, but I would like to understand what would help you more.

What we currently have is:

  1. our docs about how to build locally, pointing to the build subcommand, where the only thing you need to run is docker-compose run web build crate <CRATE_NAME> <CRATE_VERSION> (also supports building local crates)
  2. if your crate doesn't need the "full" environment including the container / system dependencies, and you only want to quickly test if the feature / metadata combination for docs work, you can use cargo docs-rs.

Building exactly like docs.rs always involves docker so it never can be as simple as cargo doc --release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants