diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index 046854bd..10aeba6e 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -16,6 +16,14 @@ v2.0.0 (expected 2024) User-requested changes +v1.1.1 (released -tba-) +====================================== + +Maintenance +----------- + +Reogranized the web site docs to be easier to navigate. + v1.1.0 (released 2024-01-13) ====================================== diff --git a/docs/source/examples/diffractometer.rst b/docs/source/examples/diffractometer.rst new file mode 100644 index 00000000..2e07778d --- /dev/null +++ b/docs/source/examples/diffractometer.rst @@ -0,0 +1,20 @@ +.. include:: /substitutions.txt + +.. _examples.diffractometer: + +Diffractometer Geometries +------------------------- + +See also the documentation for the :ref:`geometries` module. + +.. toctree:: + :maxdepth: 1 + :glob: + + notebooks/geo_* + +.. rubric:: Downloads + +Most examples are available as `Jupyter notebooks `_ on +the |hklpy| source code website: +https://github.com/bluesky/hklpy/tree/main/docs/source/examples/notebooks diff --git a/docs/source/examples/howto.rst b/docs/source/examples/howto.rst new file mode 100644 index 00000000..40a4e1ec --- /dev/null +++ b/docs/source/examples/howto.rst @@ -0,0 +1,18 @@ +.. include:: /substitutions.txt + +.. _examples.howto: + +How-to Guides +------------- + +.. toctree:: + :maxdepth: 1 + :glob: + + notebooks/how_* + +.. rubric:: Downloads + +Most examples are available as `Jupyter notebooks `_ on +the |hklpy| source code website: +https://github.com/bluesky/hklpy/tree/main/docs/source/examples/notebooks diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst deleted file mode 100644 index 4cb97bac..00000000 --- a/docs/source/examples/index.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. _examples: - -Examples -======== - -All examples are available as `Jupyter notebooks `_ on -the *hklpy* source code website: -https://github.com/bluesky/hklpy/tree/main/docs/source/examples/notebooks - -.. _examples.diffractometer: - -Diffractometer Geometries -------------------------- - -See also the documentation for the :ref:`geometries` module. - -.. toctree:: - :maxdepth: 1 - :glob: - - notebooks/geo_* - -How-to Guides -------------- - -.. toctree:: - :maxdepth: 1 - :glob: - - notebooks/how_* - -Variations ----------- - -.. toctree:: - :maxdepth: 1 - :glob: - - notebooks/var_* - -Tests and Comparisons ---------------------- - -.. toctree:: - :maxdepth: 1 - :glob: - - notebooks/tst_* diff --git a/docs/source/examples/t_and_c.rst b/docs/source/examples/t_and_c.rst new file mode 100644 index 00000000..35453dcb --- /dev/null +++ b/docs/source/examples/t_and_c.rst @@ -0,0 +1,18 @@ +.. include:: /substitutions.txt + +.. _examples.tests: + +Tests and Comparisons +--------------------- + +.. toctree:: + :maxdepth: 1 + :glob: + + notebooks/tst_* + +.. rubric:: Downloads + +Most examples are available as `Jupyter notebooks `_ on +the |hklpy| source code website: +https://github.com/bluesky/hklpy/tree/main/docs/source/examples/notebooks diff --git a/docs/source/examples/variations.rst b/docs/source/examples/variations.rst new file mode 100644 index 00000000..820d9f3b --- /dev/null +++ b/docs/source/examples/variations.rst @@ -0,0 +1,18 @@ +.. include:: /substitutions.txt + +.. _examples.variations: + +Variations +---------- + +.. toctree:: + :maxdepth: 1 + :glob: + + notebooks/var_* + +.. rubric:: Downloads + +Most examples are available as `Jupyter notebooks `_ on +the |hklpy| source code website: +https://github.com/bluesky/hklpy/tree/main/docs/source/examples/notebooks