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

Create a Glossary page #83

Closed
drbenvincent opened this issue Nov 22, 2022 · 2 comments
Closed

Create a Glossary page #83

drbenvincent opened this issue Nov 22, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@drbenvincent
Copy link
Collaborator

It would be very useful to have something like this. I'm as yet undecided if this should be very bare-bones text only, or if it should be done in a notebook with the opportunity to create plots to help explain.

If we don't want all the code visible, then this might be doable in the current nbsphinx workflow. Otherwise, we could always experiment with a quarto document (specifying to hide code cells) to build a markdown file which is then included in the docs.

@drbenvincent drbenvincent added the documentation Improvements or additions to documentation label Nov 22, 2022
@drbenvincent
Copy link
Collaborator Author

#96 added more entries to the glossary

@drbenvincent
Copy link
Collaborator Author

This is now well underway, so closing this. Further additions and improvements will happen over time, but I don't think we need an issue for this any more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant