Skip to content

Add the documentation site and the logo - #76

Merged
barrettp merged 1 commit into
mainfrom
documenter
Oct 10, 2026
Merged

barrettp merged 1 commit into
mainfrom
documenter

Conversation

@barrettp

Copy link
Copy Markdown
Member
  • Documentation: a Documenter.jl site (docs/make.jl, docs/Project.toml, and a Docs workflow that builds it on pull requests and deploys it to gh-pages from main). The usage and field notes moved to docs/src, with a new home page and a reference page (the exported functions, and the others under Internals). Docstrings added for load, AtomicLevel and AtomicLine that had none.
  • Logo: Chandra pointing at an accreting black hole, above the Fe K emission lines that Radix computes (two slabs, log ξ = 1 and 3: Kα, Kβ, Fe XXV and Fe XXVI) with Poisson noise. logo.svg, logo-dark.svg and favicon.ico are in docs/src/assets; docs/logo/spectrum.jl and logo.jl make them (spectrum.jl has not been run end to end: fek.csv came from the saved output of the two Radix runs).
  • The README has the logo and badges.

Before merging: the docs URL (juliaastro.org/Radix.jl) in the README badge and docs/make.jl is an assumption, and GitHub Pages has to be set to serve gh-pages. The docs build locally without errors.

🤖 Generated with Claude Code

Documenter.jl site (docs/make.jl, the Docs workflow), the usage and field
pages moved to docs/src, a reference page, docstrings for load, AtomicLevel
and AtomicLine, and the logo: Chandra pointing at an accreting black hole
above the Fe K emission lines that Radix computes, with Poisson noise
(docs/logo has the scripts that make it).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@barrettp
barrettp merged commit 9c00373 into main Oct 10, 2026
6 checks passed
@barrettp
barrettp deleted the documenter branch October 10, 2026 19:46
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.

1 participant