Skip to content

Add Documenter site skeleton for MFIIDD#44

Merged
sbfnk merged 1 commit into
spike/package-mfiiddfrom
docs/documenter-skeleton
Jun 29, 2026
Merged

Add Documenter site skeleton for MFIIDD#44
sbfnk merged 1 commit into
spike/package-mfiiddfrom
docs/documenter-skeleton

Conversation

@sbfnk-bot

Copy link
Copy Markdown
Collaborator

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-linked MFIIDD.
  • docs/make.jlmakedocs + deploydocs configured to publish under the api/ 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@autodocs reference for the MFIIDD module.
  • .gitignore — exclude docs/build/ and docs/Manifest.toml.

Builds cleanly locally:

julia --project=docs -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate(); include("docs/make.jl")'

Out of scope

  • Deployment from CI requires a workflow under .github/workflows/; I have not added it here. Wiring deploydocs into the existing deploy.yml (or a separate docs.yml) is a small follow-up that needs your call on the gh-pages layout.
  • Updating the qmd "see source" links to point at the rendered API page is a follow-up that should land after Replace include= source dumps with MFIIDD.source_for #43 (the CodeTracking PR) merges so the qmd changes don't conflict.

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>
@sbfnk-bot sbfnk-bot requested a review from sbfnk May 11, 2026 08:37
@coderabbitai

coderabbitai Bot commented May 11, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 62b8f3a1-6d3b-4621-931a-07331a4a9baa

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • ✅ Review completed - (🔄 Check again to review again)
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/documenter-skeleton

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sbfnk sbfnk marked this pull request as ready for review June 29, 2026 07:33
@sbfnk sbfnk merged commit 0ce16fa into spike/package-mfiidd Jun 29, 2026
2 checks passed
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