Improve Logical Flow of Documentation

[CSSFrancis]

Description of the change

I feel like I always get lost in the Rosettasciio documentation. Most of the time I just want to go to this page https://hyperspy.org/rosettasciio/user_guide/supported_formats/index.html but it's always like 2-3 levels down. I also
almost end up going to the File Specifications page first.

Rosettasciio has a lot of documentation but it's not apparent from the home page :)

Progress of the PR

• Grid to Front Page
• Make User Guide Look Cleaner
• ready for review.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.84%. Comparing base (623328f) to head (b43231a).
Report is 7 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #324   +/-   ##
=======================================
  Coverage   87.84%   87.84%           
=======================================
  Files          85       85           
  Lines       11242    11242           
  Branches     2082     2082           
=======================================
  Hits         9875     9875           
  Misses        868      868           
  Partials      499      499           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jlaehne]

Very good initiative, I have the same experience. But lets have a grid directly on the start page (similar to https://hyperspy.org/exspy/ ), so that one can get to the supported formats with one click!

[jlaehne]

I think you need to add the extension "sphinx_design" to make the grid work.

[CSSFrancis]

@jlaehne What do you think the User Guide should show? It might be nice to just jump straight to installation and have people use the side bar for something else?

[jlaehne]

@jlaehne What do you think the User Guide should show? It might be nice to just jump straight to installation and have people use the side bar for something else?

As all sections are now accessible from the front page as well that would indeed make sense.

Also, I think the table of contents on the front page could be dropped now.

Finally, I would put API before file specifications both in the header and the grid.

[ericpre]

Thank you @CSSFrancis, this has been bugging me for a while too and these changes are useful!
Most of the time, what we need to access is the "Supported formats" section and it would much better to have the link in the top bar too. I don't know if this is possible without taking that section out of the "User guide" section - in which case, the user guide could be simplify to installation, a couple of example on how to and link to the Supported formats" section.

[jlaehne]

There are some formatting issues in the preview that should be related to indentation errors.

[jlaehne]

Do you want to fix the formatting issues and conflicts. Would be nice to have this one in soon :-)

[CSSFrancis]

@jlaehne it should be good now!

[ericpre]

The documentation warning needs to be fixed to make the documentation build pass.

Should the further improvement with the user guide done in a follow up PR?

[ericpre]

Suggested change

.. include:: install.rst

[ericpre]

The "supported file formats" section is now outside of the user guide. Maybe add a sentence mentioned it and linking to it?

It would be good to have a usage page that shows how to use with and without HyperSpy.

[ericpre]

There is currently very little on "in-depth information on key concepts of RosettaSciIO" while there are information elsewhere. Should be the generic API section be moved here, as part of the "how to use without hyperspy"?

[CSSFrancis]

Fair Enough. I think we can add that later however.

[ericpre]

Failure are unrelated