Skip to content

Improve docs further#134

Open
ebrahimebrahim wants to merge 2 commits intomainfrom
improve-docs-further
Open

Improve docs further#134
ebrahimebrahim wants to merge 2 commits intomainfrom
improve-docs-further

Conversation

@ebrahimebrahim
Copy link
Copy Markdown
Collaborator

@ebrahimebrahim ebrahimebrahim commented Apr 8, 2026

Major documentation improvements:

  • Move the CONTRIBUTING.md to a "dev guide" page that shows up in the docs. Content is not changed much.
  • Autogenerate "tutorial" pages out of the notebooks using a script update-notebook-pages.py. The idea is that we would run this to generate markdown files automatically from the notebooks, and then we commit those markdown files

Before merging this:


Check out the docs! https://kwneuro--134.org.readthedocs.build/en/134/

ebrahimebrahim and others added 2 commits April 7, 2026 22:15
These heavy/fragile ML dependencies are now opt-in rather than required
for the base install. Core analysis (DTI, CSD, registration, template
building) works with just `pip install kwneuro`; optional tools are
available via `pip install kwneuro[hdbet,tractseg,noddi,combat]` or
`pip install kwneuro[all]`.

Source modules use lazy imports with clear ImportError messages. CI
Python matrix bumped from [3.10, 3.12] to [3.10, 3.13].

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move CONTRIBUTING.md content into docs/developer-guide.md as the
canonical source, with a thin redirect left in .github/. Add a script
to convert Jupytext notebooks into pre-rendered Markdown tutorial pages
for Sphinx. Exclude auto-generated tutorial files from pre-commit hooks.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ebrahimebrahim ebrahimebrahim requested a review from sadhana-r April 8, 2026 02:52
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