search

typelevel / sbt-typelevel

Let sbt work for you.
https://typelevel.org/sbt-typelevel/
Apache License 2.0
171 stars 49 forks source link

Scaladoc 3 not linking to sources #323

Closed armanbilge closed 2 years ago

armanbilge commented 2 years ago

At least, I can't see where the links are 🧐 Noticed this while looking at: https://www.javadoc.io/doc/org.typelevel/cats-docs_3/latest/cats/data/Op.html

Note the 2.13 version of the docs has a clear link to the source. https://www.javadoc.io/doc/org.typelevel/cats-docs_2.13/latest/cats/data/Op.html

This might be an upstream problem, but we should check that we've configured it right before complaining 😅

https://github.com/typelevel/sbt-typelevel/blob/b2cabecd3441d6292a186b62d87892f3796ca17b/settings/src/main/scala/org/typelevel/sbt/TypelevelSettingsPlugin.scala#L180-L181

Aside: I think this setting should probably be moved to the TypelevelGitHubPlugin in 0.5.0, I don't think it applies in general.

armanbilge commented 2 years ago

Oh, I think we're just missing the setting altogether.

-doc-source-url  Legacy option from Scala 2. Use -source-links instead.
  -source-links  Source links provide a mapping between file in documentation and code repository.

Ok, there are lots of fun settings in there we can enable 😃 

                -project  The name of the project.
         -project-footer  A footer on every Scaladoc page.
           -project-logo  Path to the file that contains the project's logo. Provided path can be absolute or relative to the
                          project root directory.
            -project-url  The source repository of your project.
        -project-version  The current version of your project.
               -revision  Revision (branch or ref) used to build project project