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.

Sign up for GitHub

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

Restore custom CSS/assets for Javadoc #276

Closed
2 tasks done
MGaetan89 opened this issue Jul 17, 2024 · 3 comments · Fixed by #281 or robolectric/robolectric#9515
Closed
2 tasks done

Restore custom CSS/assets for Javadoc #276

MGaetan89 opened this issue Jul 17, 2024 · 3 comments · Fixed by #281 or robolectric/robolectric#9515

Comments

@MGaetan89
Copy link
Member

MGaetan89 commented Jul 17, 2024 •
edited
Loading

Context

While working on migrating Robolectric's buildSrc folder to Kotlin, I stumbled upon this line:
https://github.com/robolectric/robolectric/blob/0156803c11ed2109ac53b0c5843d9b7cb7c6ecd1/buildSrc/src/main/groovy/org/robolectric/gradle/DeployedRoboJavaModulePlugin.groovy#L28

However, since the new website, this file does not exist anymore:
Screenshot 2024-07-17 at 10 29 45

Tasks

The goal of this ticket is to restore these files and all their related resources.

Known missing files:
@MGaetan89 MGaetan89 mentioned this issue Aug 7, 2024
Merged
MGaetan89 added a commit to MGaetan89/robolectric that referenced this issue Aug 19, 2024
@MGaetan89
De-duplicate Javadoc config
3caf7e9 
The configuration of the Javadoc tasks was done in two places: the root `build.gradle` file and the `DeployedRoboJavaModulePlugin` plugin.

However, it seems that only the configuration in the root `build.gradle` file was taken into consideration.

This PR updates the project to only keep the configuration from the root `build.gradle` file.

- This closes robolectric/robolectric.github.io#276, since `assets/css/main.css` was actually no longer used.
- This also answers robolectric#9430 (comment): the `version` was set on the project.
It has nothing to do with Javadoc, and it's still done here: https://github.com/robolectric/robolectric/blob/e24baa272f30bc21b2aab78f16e18c0ce94a7dcd/build.gradle#L28
@MGaetan89 MGaetan89 mentioned this issue Aug 19, 2024
Closed
MGaetan89 added a commit to MGaetan89/robolectric that referenced this issue Aug 19, 2024
@MGaetan89
De-duplicate Javadoc config
b57e848 
The configuration of the Javadoc tasks was done in two places:
the root `build.gradle` file and the `DeployedRoboJavaModulePlugin` plugin.

However, it seems that only the configuration in the root `build.gradle` file was taken into consideration.

This PR updates the project to only keep the configuration from the root `build.gradle` file.

- This closes robolectric/robolectric.github.io#276, since `assets/css/main.css` was actually no longer used.
- This also answers robolectric#9430 (comment): the `version` was set on the project.
It has nothing to do with Javadoc, and it's still done here: https://github.com/robolectric/robolectric/blob/e24baa272f30bc21b2aab78f16e18c0ce94a7dcd/build.gradle#L28
@MGaetan89 MGaetan89 linked a pull request Aug 22, 2024 that will close this issue
Add missing logo-with-bubbles-down.png #281
Merged
@MGaetan89
Copy link
Member Author

MGaetan89 commented Aug 22, 2024 •
edited
Loading

I'm starting to wonder if adding back the main.css file makes sense. From what I can see, it's only third party CSS (from the legacy HTML5 Up website), and nothing specific to Robolectric. Maybe it's better to just keep the default Javadoc stylesheet.
It doesn't seem to be included in the online Javadoc (for example, there's no reference to it in 4.13: view-source:https://robolectric.org/javadoc/4.13/), but only in the generated Javadoc jar.
Also, adding that file back means adding all the related files back as well (FontAwesome CSS, various fonts files, maybe some images).

@utzcoz @brettchabot @hoisie what do you think about dropping that file for good, and removing its reference?
https://github.com/robolectric/robolectric/blob/3911f5f9568696ab0dc72544185f089d98b5ae87/buildSrc/src/main/java/org/robolectric/gradle/DeployedRoboJavaModulePlugin.kt#L65-L69

@hoisie
Copy link
Contributor

hoisie commented Aug 22, 2024

👍 for removing it. Seems obsolete now.

MGaetan89 added a commit to MGaetan89/robolectric that referenced this issue Aug 22, 2024
@MGaetan89
Remove custom CSS from the generated Javadoc
8eaae98 
This PR removes the custom CSS linked in the generated Javadoc Jar.
That CSS file is no longer available since the new website: robolectric/robolectric.github.io#212
This closes robolectric/robolectric.github.io#276
@MGaetan89 MGaetan89 mentioned this issue Aug 22, 2024
Merged
@MGaetan89
Copy link
Member Author

👍 for removing it. Seems obsolete now.

I've submitted a PR to remove the link to main.css: robolectric/robolectric#9515

MGaetan89 added a commit to MGaetan89/robolectric that referenced this issue Aug 22, 2024
@MGaetan89
Remove custom CSS from the generated Javadoc
2d3bf13 
This PR removes the custom CSS linked in the generated Javadoc Jar.
That CSS file is no longer available since the new website: robolectric/robolectric.github.io#212
This closes robolectric/robolectric.github.io#276
MGaetan89 added a commit to robolectric/robolectric that referenced this issue Aug 22, 2024
@MGaetan89
Remove custom CSS from the generated Javadoc
1d0d4c4 
This PR removes the custom CSS linked in the generated Javadoc Jar.
That CSS file is no longer available since the new website: robolectric/robolectric.github.io#212
This closes robolectric/robolectric.github.io#276
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@hoisie @MGaetan89