Skip to content

Add documentation for NWB extensions and publishing process #2070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

bendichter
Copy link
Contributor

  • Created a new documentation file for documenting extensions, detailing the process of generating HTML documentation from YAML sources.
  • Added examples of real-world NWB extensions, including a detailed example for lab-specific metadata extension.
  • Introduced a comprehensive guide on publishing extensions, covering GitHub, PyPI, and NDX Catalog processes.
  • Documented the Spec API for creating custom neurodata types, including specifications for Groups, Datasets, Attributes, and Links.
  • Added computation times for various example scripts in the gallery.

Motivation

What was the reasoning behind this change? Please explain the changes briefly.

How to test the behavior?

Show how to reproduce the new behavior (can be a bug fix or a new feature)

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff check . && codespell from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

- Created a new documentation file for documenting extensions, detailing the process of generating HTML documentation from YAML sources.
- Added examples of real-world NWB extensions, including a detailed example for lab-specific metadata extension.
- Introduced a comprehensive guide on publishing extensions, covering GitHub, PyPI, and NDX Catalog processes.
- Documented the Spec API for creating custom neurodata types, including specifications for Groups, Datasets, Attributes, and Links.
- Added computation times for various example scripts in the gallery.
Copy link

codecov bot commented May 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.83%. Comparing base (b331e9c) to head (9802e80).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #2070   +/-   ##
=======================================
  Coverage   94.83%   94.83%           
=======================================
  Files          28       28           
  Lines        2749     2749           
  Branches      708      708           
=======================================
  Hits         2607     2607           
  Misses         82       82           
  Partials       60       60           
Flag Coverage Δ
integration 73.99% <ø> (ø)
unit 84.83% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bendichter bendichter marked this pull request as ready for review May 2, 2025 20:34
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.

1 participant