diff --git a/docs/source/conf.py b/docs/source/conf.py index 9d26f7c..4d5dfe5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,7 +19,7 @@ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', - 'sphinx.ext.autosummary', + # 'sphinx.ext.autosummary', 'myst_parser', # 'sphinx_autodoc_typehints', ] @@ -48,3 +48,9 @@ # napoleon_include_init_with_doc = False # napoleon_include_special_with_doc = True # napoleon_attr_annotations = True + +numpydoc_xref_param_type = True + +# The reST default role (used for this markup: `text`) to use for all +# documents. +default_role = "obj" diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst new file mode 100644 index 0000000..b2d50b7 --- /dev/null +++ b/docs/source/glossary.rst @@ -0,0 +1,128 @@ +Glossary +======== + +This scientific library assumes from its users a large amount of knowledge and a familiarity with +a variety of terminology related to the topic. Furthermore, some amount of naming conventions have +been created here to encode all the necessary functionality in code. This page serves to briefly +explain and define all the terms used throughout the library, both the ones used as a standard in +the wider scientific literature, and the ones specified by this library. For more details, please +see the :doc:`theory` pages. + + +Glossary +-------- + +Most relevant terms +^^^^^^^^^^^^^^^^^^^ + +.. glossary:: + + resolution + The ability of an :term:`instrument` to show results in detail. The better the resolution, + the higher the detail and the less broad the peaks. + + resolution function + A mathematical function that models the :term:`resolution` of an :term:`instrument`, as a + function of some physical property, such as energy or momentum. + + instrument + A collection of physical devices used to perform an INS experiment. Different instruments are + set up to specialise in different kinds of experiments, and so they consist of different devices + placed at different distances and made of different materials. This results in different + :term:`resolution` profiles. + + version + A particular combination of parameters for an :term:`instrument`. Over time, instruments are + upgraded by switching out and rearranging their components, resulting in a changed + :term:`resolution` (hopefully improved!). For past and future compatibility, every time an + upgrade significant enough to alter the :term:`resolution` is done, a new "version" is + created for that :term:`instrument`. + + setting + A set of :term:`options