Skip to content

Commit

Permalink
Bring the badge back (#179)
Browse files Browse the repository at this point in the history 
* actually use the var for the julia colors

* (in the docs folder as well)

* badge

* Revert "actually use the var for the julia colors"

This reverts commit 0a11e6f.

* Revert "(in the docs folder as well)"

This reverts commit 191cccb.

* correct url

* missed quote
  • Loading branch information
@tpoisot
tpoisot committed Sep 18, 2024
1 parent 3b7bbfd commit 763aa13
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/writer.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,9 @@ function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Nod
# @infiltrate
anchor_id = Documenter.anchor_label(docs.anchor)
# Docstring header based on the name of the binding and it's category.
_badge_text = """<Badge type="info" class="jlObjectType jl$(Documenter.doccat(docs.object))" text="$(Documenter.doccat(docs.object))" />"""
print(io ,"""<details class='jldocstring custom-block' open>
<summary><a id='$(anchor_id)' href='#$(anchor_id)'>#</a> <span class="jlbinding">$(docs.object.binding)</span> &mdash; <span class="jlobjecttype jl$(Documenter.doccat(docs.object))">$(Documenter.doccat(docs.object))</span></summary>\n
<summary><a id='$(anchor_id)' href='#$(anchor_id)'>#</a> <span class="jlbinding">$(docs.object.binding)</span> $(_badge_text)</summary>\n
""")
# Body. May contain several concatenated docstrings.
renderdoc(io, mime, node, page, doc; kwargs...)
Expand Down

7 comments on commit 763aa13

@avik-pal
Copy link
Member

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/115501

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.2 -m "<description of version>" 763aa134f8a9be7c0571ba107a0bf091c62aa8da
git push origin v0.1.2

@asinghvi17
Copy link
Collaborator

Choose a reason for hiding this comment

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

Isn't this a severely breaking release for people who have custom CSS?

@lazarusA
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it is. We should include some instructions on how to adapt to the new release for those cases. Let's try to put something out soon. The PR for versioning I would say is ready, just need to copy/paste things to the template. After that, I would try to address and document the issue for above.

@avik-pal
Copy link
Member

Choose a reason for hiding this comment

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

Should we yank?

@avik-pal
Copy link
Member

Choose a reason for hiding this comment

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

Isn't this a severely breaking release for people who have custom CSS?

Will it though? Won't it just render with the default div if it doesn't find jldocstring?

@avik-pal
Copy link
Member

Choose a reason for hiding this comment

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

See https://lux.csail.mit.edu/previews/PR943/api/Lux/layers#containers. It just prints it without a border

Please sign in to comment.