Add Documenter site skeleton for MFIIDD#44
Merged
Conversation
docs/Project.toml + docs/make.jl + docs/src/{index,api}.md generate an
@autodocs API reference for the MFIIDD module under /api. Run locally
with:
julia --project=docs -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate(); include("docs/make.jl")'
Deployment to gh-pages is not wired up in CI yet — that belongs in
.github/workflows and is outside the scope of this PR.
Co-authored-by: sbfnk <sebastian.funk@lshtm.ac.uk>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This was referenced Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Second half of seabbs's suggestion on #39: stand up a Documenter site for the package so qmd "see source" pointers can target rendered API docs rather than the source files directly.
Summary
docs/Project.toml— Documenter + dev-linkedMFIIDD.docs/make.jl—makedocs+deploydocsconfigured to publish under theapi/sub-path of the existing course gh-pages site so it sits alongside Quarto output without clobbering.docs/src/index.md— landing page with build instructions.docs/src/api.md—@autodocsreference for theMFIIDDmodule..gitignore— excludedocs/build/anddocs/Manifest.toml.Builds cleanly locally:
Out of scope
.github/workflows/; I have not added it here. Wiring deploydocs into the existingdeploy.yml(or a separatedocs.yml) is a small follow-up that needs your call on the gh-pages layout.