Skip to content
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

Schema documentation does not reflect the latest version #601

Open
stephprince opened this issue Dec 12, 2024 · 1 comment
Open

Schema documentation does not reflect the latest version #601

stephprince opened this issue Dec 12, 2024 · 1 comment
Labels
category: bug errors in the code or code behavior topic: docs Issues related to documentation

Comments

@stephprince
Copy link
Contributor

The schema format overview documentation page does not reflect the stable/latest versions of the schema, it is displaying version 2.7.0 instead of 2.8.0/2.9.0-alpha.

The readthedocs builds have succeeded, but output from the logs suggests that the latest namespace version is ignored because namespace version 2.7.0 is already loaded. It's not clear to me why this would be the case.

python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v8.1.3
/home/docs/checkouts/readthedocs.org/user_builds/nwb-schema/checkouts/latest/docs/format/source/conf.py:220: SyntaxWarning: invalid escape sequence '\s'
  """
loading translations [en]... done
making output directory... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
loading intersphinx inventory 'hdmf-common-schema' from https://hdmf-common-schema.readthedocs.io/en/stable/objects.inv ...
/home/docs/checkouts/readthedocs.org/user_builds/nwb-schema/envs/latest/lib/python3.12/site-packages/hdmf/spec/namespace.py:535: UserWarning: Ignoring cached namespace 'core' version 2.9.0-alpha because version 2.7.0 is already loaded.
  warn("Ignoring cached namespace '%s' version %s because version %s is already loaded."
@stephprince stephprince added category: bug errors in the code or code behavior topic: docs Issues related to documentation labels Dec 12, 2024
@stephprince
Copy link
Contributor Author

Ah, I forgot that pynwb 2.8.3 does not yet support nwb-schema 2.8.0. Does this mean that the format overview page will always reflect the latest pynwb-supported version of the schema?

I can close this issue if that is the expected behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: bug errors in the code or code behavior topic: docs Issues related to documentation
Projects
None yet
Development

No branches or pull requests

1 participant