-
Notifications
You must be signed in to change notification settings - Fork 15
Simplified MultiDocumenter.jl #44
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
Conversation
Apologies for the last minute additions. This discussion inspired me to add in an astropy comparison page. Happy to move it to a separate PR though if preferred |
The way the comparison tables are written, especially for multiple packages in a single row, makes the description seem clunky. We could do one row per package and have the python counterpart span multiple rows, but I don't think that's feasible in basic markdown without also writing HTML :( |
versions = nothing, | ||
) | ||
@info "Deploy complete" | ||
if "deploy" in ARGS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does the deploy need to be under a conditional? IIRC, deplyodocs
automatically identifies if it's in a CI and so if it needs to run.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, it still throws a warning though, so I just did this to get around it. No strong feelings either way tho
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
xref: #47 (comment)
Oh I absolutely agree. The dream would be do have something like CommonMark.jl support MichaelHatherly/CommonMark.jl#41, then we could sprinkle in some |
I noticed that we have a good amount of real estate in the dropdown menu, so I also included the associated brief taglines for each package to try and make things more descriptive for newcomers (52d86c2). Was pretty easy to add with the new autogen system we're trying, and seems to work well on mobile and with line wrapping idk, still playing around with it. What do you think? |
Hmm, that might end up being too cluttered. |
This reverts commit 52d86c2.
sg, just put back (d4ef2fd) |
Everything looks good! Merging |
PR doc preview: https://JuliaAstro.github.io/previews/PR44/docs/
Currently, we need to keep 4 different places in sync manually when referring to packages:
I feel like this can make doc maintenance pretty error prone. To help alleviate this, this PR instead treats
src/JuliaAstroDocs.jl
as our single source of truth.Tracking navbar item overlap issue here for smaller screen sizes: JuliaComputing/MultiDocumenter.jl#35
Other changes