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

Jump to bottom

Add -header/-footer options described in docs to Scaladoc tool for parity with Javadoc #9903

Open
scabug opened this issue Aug 24, 2016 · 5 comments
Open

Add -header/-footer options described in docs to Scaladoc tool for parity with Javadoc #9903

scabug opened this issue Aug 24, 2016 · 5 comments
Labels
enhancement help wanted scaladoc tool
Milestone
Backlog

Comments

@scabug
Copy link

scabug commented Aug 24, 2016 •
edited by retronym

I would like to place the script below in my Scaladoc header or footer:

<script type='text/javascript' src='http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>

Doing so would allow me to write math symbols in my Javadoc for a complex machine learning library I am writing which involves lots of math.

Unfortunately, I can't find anyway to do so. There is -doc-footer, but this escapes the HTML before inserting it into the doc so that it doesn't render.

The Scaladoc code (btw, this is an old commit. where is the current code?) references -header and -footer options, but these don't appear to actually exist. I'm guessing whoever wrote this class copy/pasted from the Javadoc code? Would it be possible to add these methods for parity with Javadoc?
@scabug
Copy link
Author

scabug commented Aug 24, 2016

Imported From: https://issues.scala-lang.org/browse/SI-9903?orig=1
Reporter: Benjamin McCann (benmccann)

@scabug
Copy link
Author

scabug commented Sep 29, 2016

@SethTisue said:
context: http://stackoverflow.com/questions/15996651/is-there-a-way-to-include-math-formulae-in-scaladoc/32114551#32114551

@scabug
Copy link
Author

scabug commented Sep 29, 2016

Brandon Barker (bebarker) said:
I'd be interested in this, and would be willing to take a stab at it. Any thoughts or suggestions, @ureche?

As @SethTisue told me, Scaladoc is part of the Scala compiler so it should be in the https://github.com/scala/scala repository, mostly under src/scaladoc/scala/tools/nsc, but I haven't looked into it yet.

It looks like Spark has solved the problem by directly editing api-docs.js.

Could we make this the default behavior?

@scabug
Copy link
Author

scabug commented Nov 2, 2016

Benjamin McCann (benmccann) said:
I don't think @ureche got notified about this. Usually JIRA puts the name in blue. I can't get it to auto-complete on @ mentions though, so it seems that functionality is disabled or broken.

@scabug
Copy link
Author

scabug commented Nov 7, 2016

@SethTisue said:
@VladUreche auto-complete worked for me just now

@scabug scabug added this to the Backlog milestone Apr 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted scaladoc tool
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
2 participants
@SethTisue @scabug