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

Render docs for experimental namespace #56

Open
oruebel opened this issue Mar 30, 2021 · 2 comments
Open

Render docs for experimental namespace #56

oruebel opened this issue Mar 30, 2021 · 2 comments
Assignees
Labels
help wanted: good first issue request for community contributions that are good for new contributors priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation
Milestone

Comments

@oruebel
Copy link
Contributor

oruebel commented Mar 30, 2021

The docs for the new experimental namespace are currently not being rendered on ReadTheDocs. This will likely require some changes to the setup of how the docs are generated and/or the hdmf-docutils.

@oruebel oruebel added help wanted: good first issue request for community contributions that are good for new contributors priority: high impacts proper operation or use of feature important to most users topic: docs issues related to documentation priority: medium non-critical problem and/or affecting only a small set of NWB users and removed priority: high impacts proper operation or use of feature important to most users labels Sep 11, 2021
@mavaylon1
Copy link
Contributor

@oruebel Is this still needed?

@oruebel
Copy link
Contributor Author

oruebel commented Sep 22, 2022

Yes, this is still an issue. The problem is that the docs only process the main namespace hdfm-common

- name: hdmf-common

while the second namespace hdfm-experimental is being ignored:

- name: hdmf-experimental

As a result, ExternalResources and EnumData are not being rendered on the page, e.g., as part of the type hierarchy:

https://hdmf-common-schema.readthedocs.io/en/latest/format.html#type-hierarchy

Fixing this for the docs, will require some trickery on the either the setup here in conf.py or potentially on the hdfm-docutils to support multiple namespaces.

@rly rly assigned oruebel and unassigned ajtritt Jan 5, 2023
@rly rly added this to the Future milestone Jan 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted: good first issue request for community contributions that are good for new contributors priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants