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

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

Closed
ghost opened this issue May 6, 2019 · 11 comments
Closed

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

ghost opened this issue May 6, 2019 · 11 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR.

Comments

@ghost
Copy link

ghost commented May 6, 2019

No description provided.

@VitalyAnkh
Copy link

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

@hellow554
Copy link
Contributor

hellow554 commented May 6, 2019

@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

@rustbot rustbot added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. labels May 6, 2019
@DevQps
Copy link
Contributor

DevQps commented May 7, 2019

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?

@hellow554
Copy link
Contributor

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

@rustbot rustbot added C-feature-request Category: A feature request, i.e: not implemented / a PR. and removed C-enhancement Category: An issue proposing an enhancement or a PR with one. labels May 17, 2019
@XVilka
Copy link

XVilka commented Jun 6, 2019

Related: rust-lang/mdBook#88

@jonas-schievink
Copy link
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.

@hellow554
Copy link
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)

@XVilka
Copy link

XVilka commented Aug 19, 2019

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

@jonas-schievink jonas-schievink added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Mar 6, 2020
@jyn514
Copy link
Member

jyn514 commented Nov 4, 2020

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.

@jyn514
Copy link
Member

jyn514 commented Dec 16, 2020

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

@jyn514 jyn514 removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 16, 2020
@Dylan-DPC
Copy link
Member

Closing this as it is better suited for an external tool

@Dylan-DPC Dylan-DPC closed this as not planned Won't fix, can't repro, duplicate, stale Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR.
Projects
None yet
Development

No branches or pull requests

8 participants