apache / apache/lucene

gradle javadocs doesn't incorporate CSS/JS [LUCENE-9210]

Open
#10,250 1 comment 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Major type:task
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

We add to the javadoc css/jss some stuff:

- Prettify.css/js (syntax highlighting)
- a few styles to migrate table cellpadding: #10249

The ant task concatenates the stuff to the end of the resulting javadocs css/js.

We should either do this also in the gradle build or remove our reliance on this stuff.

---
Migrated from [LUCENE-9210](https://issues.apache.org/jira/browse/LUCENE-9210) by Robert Muir (@rmuir)

Contributor guide

Open the contributing guide

Research direction

Compare the Ant task that concatenates Prettify.css/js and table-cellpadding styles with the Gradle build's Javadoc entry point and generated Javadoc assets. Determine whether Gradle should include the same CSS/JS or whether the Javadocs can stop relying on them; done means the chosen approach produces correct Javadocs without the reported mismatch.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, java, javascript
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.