LumiSpy / lumispy

Luminescence data analysis with HyperSpy.
https://lumispy.org
GNU General Public License v3.0
26 stars 18 forks source link

Small improvements to documentation #193

Closed jlaehne closed 1 year ago

jlaehne commented 1 year ago

Description of the change

Fix some typos and add image illustrating hyperspectral data to introduction. Fixed some issues with links in the documentation. Adapted the documentation folder structure to other projects in the hyperspy ecosystem (get rid of extra source folder and rename build to _build)

Progress of the PR

codecov-commenter commented 1 year ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (cf48f32) to head (15566e3). Report is 46 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #193 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 12 12 Lines 554 554 ========================================= Hits 554 554 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jlaehne commented 1 year ago

The change in the folder structure has to be also adapted on ReadTheDocs. Can you add me as maintainer of the LumiSpy project on ReadTheDocs @jordiferrero ?