diff --git a/.gitignore b/.gitignore index 8eb3f5d5..481e66c2 100644 --- a/.gitignore +++ b/.gitignore @@ -130,4 +130,5 @@ notebooks/tutorials/Data/ # Exclude sphinx gallery files docs/source/auto_examples/ -docs/source/gen_modules/ \ No newline at end of file +docs/source/gen_modules/ +docs/source/sg_execution_times.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index d0faa56b..7789eb74 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,7 +26,7 @@ project = 'f3dasm' author = 'Martin van der Schelling' -copyright = '2022, Martin van der Schelling' +copyright = '2024, Martin van der Schelling' version = '1.4.8' release = '1.4.8' diff --git a/docs/source/readme.rst b/docs/source/readme.rst index a1c8e0d3..f823774b 100644 --- a/docs/source/readme.rst +++ b/docs/source/readme.rst @@ -27,13 +27,14 @@ Some of the key features of are: - The framework is integrated with `hydra `_ configuration manager, to easily manage and run experiments. -.. include:: auto_examples/001_domain/index.rst -.. include:: auto_examples/002_experimentdata/index.rst +.. .. include:: auto_examples/001_domain/index.rst -.. include:: auto_examples/003_datageneration/index.rst +.. .. include:: auto_examples/002_experimentdata/index.rst -.. include:: auto_examples/004_optimization/index.rst +.. .. include:: auto_examples/003_datageneration/index.rst + +.. .. include:: auto_examples/004_optimization/index.rst Getting started --------------- diff --git a/docs/source/sg_execution_times.rst b/docs/source/sg_execution_times.rst deleted file mode 100644 index 824636ed..00000000 --- a/docs/source/sg_execution_times.rst +++ /dev/null @@ -1,70 +0,0 @@ - -:orphan: - -.. _sphx_glr_sg_execution_times: - - -Computation times -================= -**00:00.004** total execution time for 12 files **from all galleries**: - -.. container:: - - .. raw:: html - - - - - - - - .. list-table:: - :header-rows: 1 - :class: table table-striped sg-datatable - - * - Example - - Time - - Mem (MB) - * - :ref:`sphx_glr_auto_examples_001_domain_001_domain_creation.py` (``../../examples/001_domain/001_domain_creation.py``) - - 00:00.004 - - 0.0 - * - :ref:`sphx_glr_auto_examples_001_domain_002_own_sampler.py` (``../../examples/001_domain/002_own_sampler.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_001_domain_003_builtin_sampler.py` (``../../examples/001_domain/003_builtin_sampler.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_002_experimentdata_001_experimentdata.py` (``../../examples/002_experimentdata/001_experimentdata.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_002_experimentdata_002_experimentdata_storing.py` (``../../examples/002_experimentdata/002_experimentdata_storing.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_003_datageneration_001_own_datagenerator.py` (``../../examples/003_datageneration/001_own_datagenerator.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_003_datageneration_002_builtin_benchmarkfunctions.py` (``../../examples/003_datageneration/002_builtin_benchmarkfunctions.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_003_datageneration_003_storing.py` (``../../examples/003_datageneration/003_storing.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_004_optimization_001_builtin_optimizers.py` (``../../examples/004_optimization/001_builtin_optimizers.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_005_workflow_001_cluster_computing.py` (``../../examples/005_workflow/001_cluster_computing.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_006_hydra_001_hydra_usage.py` (``../../examples/006_hydra/001_hydra_usage.py``) - - 00:00.000 - - 0.0 - * - :ref:`sphx_glr_auto_examples_006_hydra_002_cluster_hydra.py` (``../../examples/006_hydra/002_cluster_hydra.py``) - - 00:00.000 - - 0.0