Skip to content

Add glossary to documentation #99

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.

Sign up for GitHub

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

Closed
namurphy wants to merge 3 commits into from
Closed

Add glossary to documentation #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
284ae33
Add glossary
namurphy Feb 13, 2023
784279c
Add changelog entry
namurphy Feb 13, 2023
fec2ffc
Merge branch 'main' into add-glossary
namurphy Sep 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/99.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added a glossary to the documentation.
13 changes: 13 additions & 0 deletions docs/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. currentmodule:: sunkit_instruments

.. _glossary:

********
Glossary
********

.. glossary::
:sorted:

temperature response

@nabobalis nabobalis Feb 23, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do we want to include?

  • temperature response?
  • response function?
  • gain?

Add definition here...
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A package for instrument-specific data structures and processing in the SunPy ec
code_ref/index
generated/gallery/index
whatsnew/index

glossary

Note that the code in this package is **not** maintained by or neccesarily contributed to by instrument teams.
Some instruments have individual packages for analysis in Python, including:
Expand Down