hdmf-dev / hdmf-common-schema

Specifications for pre-defined data structures provided by HDMF.
Other
3 stars 7 forks source link

Update docs and version strings for version 1.2.1 #42

Closed rly closed 3 years ago

rly commented 3 years ago

Prepare for release of hdmf-common-schema 1.2.1 on November 4, 2020.

Pending merge of https://github.com/hdmf-dev/hdmf-common-schema/pull/41

Before merging:

After merging:

  1. Create a new git tag. Pull the latest master branch locally, run git tag [version] --sign, copy and paste the release notes into the tag message, and run git push --tags.
  2. On the GitHub tags page page, click "Create release" to create a release from the new tag. Copy and paste the release notes into the release message and update the title to the version string.
  3. Check that the readthedocs "latest" and "stable" builds run and succeed

See https://hdmf-common-schema.readthedocs.io/en/latest/software_process.html for more details.

rly commented 3 years ago

The generated documentation does not list CSRMatrix or SimpleMultiContainer as children of Container for some reason. I'll work on resolving that today. I recommend we hold on merging this until that is resolved. It is probably a bug in hdmf_docutils.

rly commented 3 years ago

Oh, I know the issue. hdmf_docutils builds documentation based on the schema bundled in the latest release of hdmf instead of the local schema. https://github.com/hdmf-dev/hdmf-docutils/issues/60

rly commented 3 years ago

The issue with the wrong schema being loaded is resolved in this PR as well.