Skip to content

Adopt Configuration Explorer Template to new ScalaDoc Version#355

Open
johannesduesing wants to merge 7 commits intodevelopfrom
feature/ce-to-scaladoc-3
Open

Adopt Configuration Explorer Template to new ScalaDoc Version#355
johannesduesing wants to merge 7 commits intodevelopfrom
feature/ce-to-scaladoc-3

Conversation

@johannesduesing
Copy link
Collaborator

This PR adapts the HTML template used by the ConfigurationExplorer to match the apperance of HTML files generated by ScalaDoc 3. This became necessary, as the libraries and CSS scripts used by ScalaDoc changed significantely between both major releases. Also, this PR modifies the build configuration so the configuration explorer is execuded when sbt unidoc is run.

@johannesduesing johannesduesing requested a review from errt December 17, 2025 15:26
@johannesduesing johannesduesing self-assigned this Dec 17, 2025
@johannesduesing johannesduesing added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 17, 2025
<script type="text/javascript" src="scripts/components/Filter.js" defer="true"></script>
<script type="text/javascript" src="scripts/scaladoc-scalajs.js" defer="true"></script>
<script type="text/javascript" src="scripts/contributors.js" defer="true"></script>
<script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js" defer="true"></script>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need these pinned-version external scripts? They might unnoticeably become outdated.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I managed to remove almost all JS libraries from the template 👍

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

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants