Skip to content

Commit

Permalink
add the necessary .readthedocs.yaml file for docstring to compile
Browse files Browse the repository at this point in the history
  • Loading branch information
WilliamLwj committed Oct 24, 2024
1 parent af9fe44 commit 8336caf
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.7"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
52 changes: 52 additions & 0 deletions docs/source/sg_execution_times.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

:orphan:

.. _sphx_glr_sg_execution_times:


Computation times
=================
**00:16.282** total execution time for 6 files **from all galleries**:

.. container::

.. raw:: html

<style scoped>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
<link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
</style>
<script src="https://code.jquery.com/jquery-3.7.0.js"></script>
<script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
<script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
<script type="text/javascript" class="init">
$(document).ready( function () {
$('table.sg-datatable').DataTable({order: [[1, 'desc']]});
} );
</script>

.. list-table::
:header-rows: 1
:class: table table-striped sg-datatable

* - Example
- Time
- Mem (MB)
* - :ref:`sphx_glr_getting_started_auto_examples_plot_VHCT_Landmine.py` (``..\examples\plot_VHCT_Landmine.py``)
- 00:16.282
- 0.0
* - :ref:`sphx_glr_info_auto_examples_plot_new_algo.py` (``..\contribute_examples\plot_new_algo.py``)
- 00:00.000
- 0.0
* - :ref:`sphx_glr_info_auto_examples_plot_new_obj.py` (``..\contribute_examples\plot_new_obj.py``)
- 00:00.000
- 0.0
* - :ref:`sphx_glr_info_auto_examples_plot_new_partition.py` (``..\contribute_examples\plot_new_partition.py``)
- 00:00.000
- 0.0
* - :ref:`sphx_glr_getting_started_auto_examples_plot_HCT_Himmelblau.py` (``..\examples\plot_HCT_Himmelblau.py``)
- 00:00.000
- 0.0
* - :ref:`sphx_glr_getting_started_auto_examples_plot_HOO_Garland.py` (``..\examples\plot_HOO_Garland.py``)
- 00:00.000
- 0.0

0 comments on commit 8336caf

Please sign in to comment.