Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
iuliivasilev committed Dec 1, 2024
1 parent 251ce42 commit af4df29
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
project = 'survivors'
copyright = '2024, Iulii Vasilev'
author = 'Iulii Vasilev'
release = '1.7.0'
release = '1.7.1'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,18 @@ Documentation
Installation
Citing survivors <Citing>

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

auto_examples/plot_experiments_guide
auto_examples/plot_user_guide

Indices and tables
------------------------------

* :ref:`sphx_glr_auto_examples_plot_user_guide.py`
* :ref:`sphx_glr_auto_examples_plot_experiments_guide.py`
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
7 changes: 5 additions & 2 deletions docs/sg_execution_times.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:10.627** total execution time for 1 file **from all galleries**:
**37:24.268** total execution time for 2 files **from all galleries**:

.. container::

Expand All @@ -32,6 +32,9 @@ Computation times
* - Example
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_plot_experiments_guide.py` (``..\doc\plot_experiments_guide.py``)
- 37:24.268
- 0.0
* - :ref:`sphx_glr_auto_examples_plot_user_guide.py` (``..\doc\plot_user_guide.py``)
- 00:10.627
- 00:00.000
- 0.0

0 comments on commit af4df29

Please sign in to comment.