Skip to content

Simplified MultiDocumenter.jl#44

Merged
abhro merged 66 commits intosourcefrom
multidoc-auto-highlevels
Apr 27, 2025
Merged

Simplified MultiDocumenter.jl#44
abhro merged 66 commits intosourcefrom
multidoc-auto-highlevels

Conversation

@icweaver
Copy link
Member

@icweaver icweaver commented Apr 7, 2025

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:

  • docs/pages.jl - inlined with docs/make.jl in this PR
  • docs/src/ecosystem.md - auto-generated in this PR
  • docs/src/highlevels/<package category>.md - removed completely in this PR in favor of the ecosystem page
  • test/runtests.jl - list of packages to test now auto-generated in this PR

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

  • Using more succinct navbar item names to get around this, which may actually be preferable if this looks alright to y'all

Other changes

@icweaver icweaver requested a review from sefffal April 20, 2025 19:51
@icweaver
Copy link
Member Author

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

@abhro
Copy link
Member

abhro commented Apr 23, 2025

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
Copy link
Member

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.

Copy link
Member Author

@icweaver icweaver Apr 23, 2025

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

Copy link
Member Author

Choose a reason for hiding this comment

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

@icweaver
Copy link
Member Author

icweaver commented Apr 23, 2025

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 :(

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 <br>s to get some breathing room. As you saw, my poor workaround was to just split items with | character for now just to get something standing

Update: work around here: #61

@icweaver
Copy link
Member Author

icweaver commented Apr 25, 2025

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

image

idk, still playing around with it. What do you think?

@abhro
Copy link
Member

abhro commented Apr 27, 2025

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

image

idk, still playing around with it. What do you think?

Hmm, that might end up being too cluttered.

@icweaver
Copy link
Member Author

sg, just put back (d4ef2fd)

@abhro
Copy link
Member

abhro commented Apr 27, 2025

Everything looks good! Merging

@abhro abhro merged commit a320ab3 into source Apr 27, 2025
2 of 3 checks passed
@abhro abhro deleted the multidoc-auto-highlevels branch April 27, 2025 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants