Rendered schema should use the schema in the YAML, not from the TypeMap

hdmf-dev / hdmf-docutils

Collection of CLIs, scripts and modules useful to generate HDMF/NWB schema documentation

Other

0 stars 3 forks source link

Rendered schema should use the schema in the YAML, not from the TypeMap #60

Closed rly closed 3 years ago

rly commented 4 years ago

The docs for the schema, e.g. https://nwb-schema.readthedocs.io/en/stable/format.html, currently use the schema from the TypeMap, i.e., from HDMF or PyNWB, not from the YAML files in the schema directory. This is problematic when there is an inconsistency between the released schema and the schema used in PyNWB / HDMF.

rly commented 3 years ago

This issue is resolved by setting spec_default_type_map = hdmf.build.TypeMap(hdmf.spec.NamespaceCatalog()) or to another appropriate value in docs/conf_doc_autogen.py in the schema docs.