Skip to content

Make a pdf version of the std api reference. #60577

Closed as not planned
Closed as not planned

Description

No description provided.

Activity

  1. VitalyAnkh commented on May 6, 2019

    @VitalyAnkh

    You can use Pandoc to convert these html version document files.

  2. hellow554 commented on May 6, 2019

    @hellow554
    Contributor

    @catastrop a more detailed description would be helpful though. Do you want something like doxygen which gives you a multi-hundred page PDF?

    @rustbot modify labels: T-doc C-enhancement

  3. added
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    on May 6, 2019
  4. DevQps commented on May 7, 2019

    @DevQps
    Contributor

    It reminds me a bit of this issue: #20866 which about generating epub and pdf versions of the Book. But maybe the idea behind it can be used for this as well?

  5. hellow554 commented on May 17, 2019

    @hellow554
    Contributor

    @rustbot modify labels: -C-enhancement +C-feature-request

  6. added
    C-feature-requestCategory: A feature request, i.e: not implemented / a PR.
    and removed
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    on May 17, 2019
  7. XVilka commented on Jun 6, 2019

    @XVilka
  8. jonas-schievink commented on Jun 21, 2019

    @jonas-schievink
    Contributor

    @catastrop Please stop spamming issues, it will not get this resolved any faster. Rustdoc is not capable of outputting to PDF natively, it can only create the HTML-based documentation that is already available.

    Like someone already said, you can try using Pandoc to convert the documentation, but the result might not look very good.

    The only way to properly resolve this is by adding first-class PDF support to rustdoc, which, given the current architecture and state of rustdoc, is going to be very difficult. The rustdoc team is also only 4 people who are busy with other issues.

  9. hellow554 commented on Jul 1, 2019

    @hellow554
    Contributor

    @catastrop I don't get your arguments. Rustdoc can already be access offline, because the doc is always installed along with the standard library and the compiler. Always. Just use rustup doc --std and it will be opened in your browser right away. Locally (remove your network cable and see that it still works)

  10. XVilka commented on Aug 19, 2019

    @XVilka

    Note, that the code for generating PDF files from Markdown already exists, it just requires a bit of integration: https://github.com/Geemili/mdproof

  11. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Mar 6, 2020
  12. jyn514 commented on Nov 4, 2020

    @jyn514
    Member

    IMO this doesn't really make sense to add to Rustdoc. The way I see this happening is by implementing the JSON backend (rust-lang/rfcs#2963) and then someone in the community can then make a PDF renderer using the JSON.

  13. jyn514 commented on Dec 16, 2020

    @jyn514
    Member

    --output-format=json has landed on nightly.

  14. removed
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Dec 16, 2020
  15. Dylan-DPC commented on Dec 6, 2023

    @Dylan-DPC
    Member

    Closing this as it is better suited for an external tool

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-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-feature-requestCategory: A feature request, i.e: not implemented / a PR.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions