Skip to content

Update docs deploy branch and landing copy#224

Merged
arnodelorme merged 1 commit into
developfrom
docs/develop-docs-source
Jun 12, 2026
Merged

Update docs deploy branch and landing copy#224
arnodelorme merged 1 commit into
developfrom
docs/develop-docs-source

Conversation

@suraj-ranganath

Copy link
Copy Markdown
Member

Point documentation publishing and source links at develop, remove a deprecated Sphinx typehint extension while keeping current Sphinx, and refresh the landing and agent CLI docs for EEG researchers. Adds light/dark theme switching with light mode as the default and keeps the docs build warning-free.

@claude

claude Bot commented Jun 12, 2026

Copy link
Copy Markdown

Claude finished @suraj-ranganath's task in 1m 58s —— View job


Code review

  • Overall assessment: Safe to merge — clean docs/config PR, no behavioral code touched.
  • Highest-risk area: .github/workflows/docs.yml deploy-branch switch (intent confirmation only).
  • Merge recommendation: Safe to merge.

I read the full diff against origin/develop and verified the docs-build-relevant pieces below.

Blocking

None.

Important

None.

Nits

  • docs/source/index.rst — "Core Maintainers" section: This hardcodes a maintainer list with personal URLs into the published manual. It will drift over time and is easy to forget to update. Not a code issue, just confirm the list/affiliations are accurate and that you want it living in index.rst rather than a dedicated about/team page. (severity: nit)

Test gaps

None — docs/config only; no testable runtime behavior changed.

Things I verified (all good)

  • conf.py typehints removal is safe. Removing the sphinx_autodoc_typehints extension does not orphan the remaining config: autodoc_typehints = "description" and autodoc_typehints_format = "short" (conf.py:109-110) are core sphinx.ext.autodoc options (built-in since Sphinx 4.1), not provided by the removed third-party extension. Grep confirms no remaining references to sphinx_autodoc_typehints / always_document_param_types anywhere in the repo, and uv.lock + pyproject.toml are consistent.
  • RST underlines are correct. Both new section titles match their underline length exactly (Core Maintainers = 16/16; For EEG Researchers Working With Agents = 39/39), so no title-underline-too-short warnings — consistent with the "warning-free build" claim.
  • Theme switcher config is valid. "theme-switcher" in navbar_end plus "default_mode": "light" in html_context is the supported pydata-sphinx-theme pattern.
  • Branch references are consistent. masterdevelop is applied uniformly across docs.yml (triggers + deploy gate), conf.py github_version, and the git-command docs in changelog.rst, contributing.rst, development.rst.

One thing worth confirming (not blocking)

  • docs.yml deploy source = develop. The deploy job now publishes GitHub Pages on push to develop (was master, which isn't this repo's default branch and so was effectively dead). This means the public docs site will reflect in-progress develop content rather than a release/main branch. That matches the PR's stated intent — just confirm you're comfortable with develop driving the live site. Note: I can't modify files under .github/workflows/ myself (app permission limitation), so this is review-only.

@arnodelorme arnodelorme merged commit 8525828 into develop Jun 12, 2026
10 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