Skip to content

Commit

Permalink
Re-structure start page of documentation to hide ToC at end of page, …
Browse files Browse the repository at this point in the history
…and move metrics title to its rst file.
  • Loading branch information
Mayitzin committed Aug 22, 2023
1 parent 44bdb63 commit 6ef1c1b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 20 deletions.
3 changes: 0 additions & 3 deletions ahrs/utils/metrics.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# -*- coding: utf-8 -*-
"""
Metrics
=======
Common metrics used in 3D Orientation representations.
References
Expand Down
20 changes: 3 additions & 17 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,28 +79,14 @@ Loading and visualizing the data is left to the preference of the user.

.. toctree::
:maxdepth: 1
:hidden:

installation

.. toctree::
:maxdepth: 1
:caption: Attitude Estimators

attitude_representations
filters

.. toctree::
:maxdepth: 1
:caption: World Models

world_models

.. toctree::
:maxdepth: 1
:caption: Tools

attitude_representations
constants
metrics
constants
nomenclature

Indices
Expand Down
2 changes: 2 additions & 0 deletions docs/source/metrics.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Metrics
=======

.. automodule:: ahrs.utils.metrics
:members:

0 comments on commit 6ef1c1b

Please sign in to comment.