Skip to content
Open
Show file tree
Hide file tree
Changes from all 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/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@

html_theme_options = {
"logo_only": True,
"collapse_navigation": False,
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
5 changes: 5 additions & 0 deletions doc/examples/example1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. _example1:

Example 1
=========
Content of example 1...
13 changes: 13 additions & 0 deletions doc/examples/examples_index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _examples-index:

Examples
===================

This gallery contains the commented code for short examples illustrating simple
tasks that can be performed with LumiSpy.

.. toctree::
:maxdepth: 1

example1

3 changes: 2 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,11 @@ Contents
api/modules.rst

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Tutorials

Demo notebooks <https://github.com/LumiSpy/lumispy-demos>
examples/examples_index.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To align with the HyperSpy and ExSpy documentations, I would create a separate TOC section directly after the user guide.


.. toctree::
:maxdepth: 1
Expand Down
Loading