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

Redesign of html pages and repo structure #155

Open
domna opened this issue Feb 7, 2024 · 0 comments
Open

Redesign of html pages and repo structure #155

domna opened this issue Feb 7, 2024 · 0 comments

Comments

@domna
Copy link

domna commented Feb 7, 2024

For proper navigation it would be useful to have the html pages more approachable and selectable. Therefore, the html page generation should be redesigned.

Features

  • Make selection for requiredness, so that one can only look at required, recommended, optional fields
  • Selection to display the fields of a base class on the page it is used (maybe even with required, recommended, optional switch as soon as we have base class inheritance (BCI))
  • Make our html representations a separate repo, so we don't have to maintain a separate styling than NIAC in the same repo (makes interaction with NIAC a lot easier!)
  • Better structuring: This might be a bit offloaded to the pynxtools docs as a general point of first interaction but I think it would also be helpful to have more guidance when one comes first to the documentation.

Maybes

  • Use mkdocs instead of sphinx? (Problem: nxdl docstrings are written in rst!)

@FAIRmat-NFDI/areab Feel free to comment and extend

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

No branches or pull requests

1 participant