Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Logical Flow of Documentation #324

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,12 @@
Table of contents
=================

.. toctree::

Check warning on line 64 in doc/index.rst

View workflow job for this annotation

GitHub Actions / Build / Check links and make PR comments

toctree contains reference to nonexisting document 'user_guide/supported_formats' [toc.not_readable]
:maxdepth: 2

user_guide/index
file_specification/index
user_guide/supported_formats
jlaehne marked this conversation as resolved.
Show resolved Hide resolved
api/index
contributing
changes
33 changes: 33 additions & 0 deletions doc/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,39 @@
User Guide
==========


.. grid:: 1 3 3 3

Check failure on line 7 in doc/user_guide/index.rst

View workflow job for this annotation

GitHub Actions / Build / Check links and make PR comments

Unknown directive type "grid".
:gutter: 2

.. grid-item-card::
:link: user_guide/installing
:link-type: doc

:octicon:`rocket;2em;sd-text-info` Getting Started
^^^

New to rosettasciio or Python? The getting started guide provides an
introduction on basic usage of rosettasciio and how to install it.

.. grid-item-card::
:link: supported_formats/index
:link-type: doc

:octicon:`book;2em;sd-text-info` User Guide
^^^

This provides a nice overview of the different files that can be read and written by rosettasciio.

.. grid-item-card::
:link: interoperability
:link-type: doc

:octicon:`code-square;2em;sd-text-info` Reference
^^^

Documentation describing how to use rosettasciio with other libraries than HyperSpy.


.. toctree::
:maxdepth: 2

Expand Down
Loading