Skip to content

Make nightly version configurable #228

Description

@spacekookie

It happens from time to time that some crate can't build on a nightly version which results in broken documentation. In this case the author of the crate usually has to wait for the nightly version docs.rs uses to be bumped and hope that problems will go away.

Right now, my crate barrel fails to build documentation because the diesel version I require requires a newer nightly.

It would be so much better if, apart from bumping the nightly version from time to time, enabling users to tell docs.rs what nightly version to use. This way users can either opt-into the current nightly or pin documentation on a version they know works.

Edit After having seen https://github.com/onur/docs.rs/pull/225 I'm wondering what other work is needed to make the rust version used by docs.rs configurable.

Activity

  1. jyn514 commented on Nov 27, 2019

    @jyn514
    Member

    This should be less of an issue since we now always use the latest nightly. I would like to be able to choose between stable, beta, and nightly though. I'm not quite sure I see the use case for a specific nightly version, but if someone wants to explain I'm happy to listen :)

  2. GuillaumeGomez commented on Nov 27, 2019

    @GuillaumeGomez
    Member

    A few options used by docs.rs on rustdoc to generate docs are unstable.

  3. added
    A-buildsArea: Building the documentation for a crate
    C-enhancementCategory: This is a new feature
    on Jul 6, 2020
  4. hecatia-elegua commented on May 12, 2023

    @hecatia-elegua

    @jyn514 I found a use-case: my specific-nightly-only crate's docs.rs build will be broken until rust-lang/rust#110395 is re-implemented.

  5. jyn514 commented on May 12, 2023

    @jyn514
    Member

    @hecatia-elegua that seems like a misfeature, we should not be building docs that enable features that don't exist in the language anymore

  6. hecatia-elegua commented on May 12, 2023

    @hecatia-elegua

    @jyn514 but it is just getting re-implemented

    It felt like anything that can build locally should be able to get onto docs.rs, since it's "just" docs.
    I do understand however that there's a lack of contributors and therefore that won't happen.

    Anyways, I'll just feature gate the nightly stuff, thanks for answering!

  7. syphar commented on Oct 24, 2023

    @syphar
    Member

    I'm not sure if this will ever be possible, since we rely on nightly-only things that were builts specifically for docs.rs.

    And when docs.rs needs something new in rustdoc, we definitely need a minimum nightly version that includes this new feature. Most recent example was around how static filenames are rendered for better caching.

  8. added
    E-mediumEffort: This requires a fair amount of work
    on Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-buildsArea: Building the documentation for a crateC-enhancementCategory: This is a new featureE-mediumEffort: This requires a fair amount of work

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions