Skip to content

Update docs - #324

Open
vandalt wants to merge 21 commits into
SAIL-Labs:mainfrom
vandalt:update-docs
Open

Update docs#324
vandalt wants to merge 21 commits into
SAIL-Labs:mainfrom
vandalt:update-docs

Conversation

@vandalt

@vandalt vandalt commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

The current docs page: https://sail-labs.github.io/AMICAL/ only has part of the tutorial and seemed to come from a separate branch that was not up to date. This PR aims to include all tutorials and examples in the docs, bring it up to date with the latest branch, and integrate it to GitHub workflows.

I started by merging @benjaminpope's branch to the PR branch to build on what he had already done.

Here is a breakdown of the changes:

  • Move most of what's in the README to the docs to avoid duplicating content and make the docs more discoverable
  • Convert all remaining example*.py file to tutorial notebooks
  • Convert the tutorial.md tutorial to a "Getting Started" tutorial notebook
  • Include API docs via mkdocstrings
  • Add a workflow to build the docs and push to GitHub pages
  • Update all docstrings to respect the Numpydoc convention so they could be rendered properly (used copilot and reviewed it afterwards)

I have two questions about the documentation:

  • Where can TestSPHEREData be downloaded? I could update the tutorial to point to it.
  • The mkdocs ecosystem seems to be going through a rough patch (Material for MkDocs blog post, fpgmaas blog post. I think it's reasonable to use it for this PR to build on previous work, but it might be worth thinking about a switch to sphinx (I would be happy to help with that)

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