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

Add LaTeX support to Rustdoc #34261

Closed
AndrewBrinker opened this Issue Jun 13, 2016 · 5 comments

Comments

Projects
None yet
4 participants
@AndrewBrinker
Contributor

AndrewBrinker commented Jun 13, 2016

This has been discussed before (#17390 and #16300), but it's been a while since then, and may be worth discussing.

There are a number of options for implementing LaTeX in the browser. I believe KaTeX remains the most efficient option, and is probably the one we should go with, but if I'm wrong or if people have strong feelings in support of another option we can try something else.

I am happy to make this happen if it's something people want.

@rkruppe

This comment has been minimized.

Show comment
Hide comment
@rkruppe

rkruppe Jun 13, 2016

Contributor

Is there a common markdown extension syntax for Latex expressions? Hopefully we won't stay on hoedown forever (cf. #33771) and the surface syntax should remain the same when replacing hoedown.

Contributor

rkruppe commented Jun 13, 2016

Is there a common markdown extension syntax for Latex expressions? Hopefully we won't stay on hoedown forever (cf. #33771) and the surface syntax should remain the same when replacing hoedown.

@ghost

This comment has been minimized.

Show comment
Hide comment
@ghost

ghost Oct 13, 2016

@AndrewBrinker Curious why you closed this?

Speaking broadly, if Rust wants to be a major systems language, supporting linear algebra/signal processing applications is on the table. It already does that pretty well as a language construct, but it's exceedingly incongruous in this day and age that the docs don't.

Speaking specifically, I want to document this digital filter library I just made properly.

So I think there's a real use case here 😉

ghost commented Oct 13, 2016

@AndrewBrinker Curious why you closed this?

Speaking broadly, if Rust wants to be a major systems language, supporting linear algebra/signal processing applications is on the table. It already does that pretty well as a language construct, but it's exceedingly incongruous in this day and age that the docs don't.

Speaking specifically, I want to document this digital filter library I just made properly.

So I think there's a real use case here 😉

@AndrewBrinker

This comment has been minimized.

Show comment
Hide comment
@AndrewBrinker

AndrewBrinker Oct 13, 2016

Contributor

Oh, I didn't mean to close this!

Contributor

AndrewBrinker commented Oct 13, 2016

Oh, I didn't mean to close this!

@AndrewBrinker AndrewBrinker reopened this Oct 13, 2016

@masonium

This comment has been minimized.

Show comment
Hide comment
@masonium

masonium Nov 4, 2016

Just to put in 👍 on addressing this issue.

I'm currently working on a linear algebra library, and documentation without LaTeX is pretty painful.

I would definitely be willing to take this on in rustdoc, though this would be my first foray into the rust codebase itself.

masonium commented Nov 4, 2016

Just to put in 👍 on addressing this issue.

I'm currently working on a linear algebra library, and documentation without LaTeX is pretty painful.

I would definitely be willing to take this on in rustdoc, though this would be my first foray into the rust codebase itself.

@Mark-Simulacrum

This comment has been minimized.

Show comment
Hide comment
@Mark-Simulacrum

Mark-Simulacrum May 15, 2017

Member

I am going to close this. This is a fairly large feature request, and in my opinion needs an RFC or at least some discussion on internals.rust-lang.org. Please open a thread there if you're actively interested!

Member

Mark-Simulacrum commented May 15, 2017

I am going to close this. This is a fairly large feature request, and in my opinion needs an RFC or at least some discussion on internals.rust-lang.org. Please open a thread there if you're actively interested!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment