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

Headers and footers for scaladoc generation, including version in HTML #90

Merged
merged 2 commits into from
Mar 29, 2022

Conversation

eavilaes
Copy link
Contributor

The current version of scaladoc (sbt unidoc) generates HTML documents like the one in the screenshot below. My idea is to include in these some information about the qbeast-spark version, both in the header and the footer of the files:

Screenshot 2022-03-24 at 19 19 24

Any suggestions or modifications are more than welcome!☺️

@eavilaes eavilaes added type: documentation Improvements or additions to documentation low labels Mar 24, 2022
@eavilaes eavilaes self-assigned this Mar 24, 2022
@codecov-commenter
Copy link

codecov-commenter commented Mar 24, 2022

Codecov Report

Merging #90 (02f33ee) into main (86c6481) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #90   +/-   ##
=======================================
  Coverage   89.34%   89.34%           
=======================================
  Files          60       60           
  Lines        1286     1286           
  Branches      100      100           
=======================================
  Hits         1149     1149           
  Misses        137      137           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cb06254...02f33ee. Read the comment docs.

@osopardo1
Copy link
Member

Header is 🔝

I don't know if for the footer is necessary to include the GitHub link. Did you inspire by other projects? In any case, seems good!

@eavilaes
Copy link
Contributor Author

Header is 🔝

I don't know if for the footer is necessary to include the GitHub link. Did you inspire by other projects? In any case, seems good!

As there's no reference or link to the project in the docs, I thought it was great to have it. But I agree it looks kinda weird🙃

@osopardo1 osopardo1 self-requested a review March 25, 2022 14:18
@eavilaes eavilaes merged commit f146d92 into Qbeast-io:main Mar 29, 2022
@eavilaes eavilaes deleted the generate-scaladocs branch March 29, 2022 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants