rust-lang / rust-lang/docs.rs

Feature Request: Build repos from git and add an API to do so

Open
#3,118 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

I would like docsrs to be able to build a crate/workspace from a provided git-link and have that ability be exposed through an API of the webserver as well. This would then be similar to /crate/name/version/rebuild but the user of the API would need to provide a git-uri too. This would be awesome to have for development internal documentation where the crate is not yet mature enough to push onto crates.io but one wants to have a nice webpage with the documentation, which has some of the docsrs features that pure rustdoc does not have, e. g., a list of all crate-features, selecting specific architecture versions of the crate etc.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing /crate/name/version/rebuild web-server API and the crate/workspace build flow. Define how a provided git URI, including development-only crates, should be validated and built, and how the API should expose the resulting documentation. Done means the design and implementation support git-based builds while preserving the documented docs.rs features for the generated page.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, rust
Domain
api, backend, build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.