Skip to content

Commit

Permalink
small improvements to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaehne committed Jul 19, 2023
1 parent f1016e6 commit 541d22c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
6 changes: 1 addition & 5 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,9 @@
]

intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"sphinx": ("https://www.sphinx-doc.org/en/master/", None),
"hyperspyweb": ("https://hyperspy.org/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"hyperspy": ("https://hyperspy.org/hyperspy-doc/current/", None),
"rsciio": ("https://hyperspy.org/rosettasciio/", None),
"kikuchipy": ("https://kikuchipy.org/en/latest/", None),
}
intersphinx_disabled_domains = ["std"]
Expand Down
11 changes: 7 additions & 4 deletions doc/source/user_guide/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,12 @@ by the following figure:
:alt: Illustration of hyperspectral datasets in different dimensionalities.

To facilitate working with these datasets, HyperSpy distinguishes between
:external+hyperspy:doc:`...navigation and signal dimensions` that can be
addressed separately and thus, for example, operations on a single spectrum can
be easily mapped to a whole dataset.
`navigation and signal dimensions <https://hyperspy.org/hyperspy-doc/current/user_guide/getting_started.html#the-navigation-and-signal-dimensions>`_
that can be addressed separately and thus, for example, operations on a single
spectrum can be easily mapped to a whole dataset.

..
Eith HyperSpy 2.0 update link above to :external+hyperspy:doc:`navigation and signal dimensions <navigation-signal-dimensions>`
Notable features that **HyperSpy** provides are:

Expand Down Expand Up @@ -152,6 +155,6 @@ to additional signal classes. In the near future, the following functions
should be developed:

- handling of transient (time-resolved) data,
- reading of common PL data formats (see :external+rsciio:`...`),
- reading of common PL data formats (see :external+rsciio:ref:`supported-formats` of RosettaSciIO),
- more dedicated analysis functionalities,
- ...

0 comments on commit 541d22c

Please sign in to comment.