diff --git a/doc/conf.py b/doc/conf.py index 30b2b25..535bde2 100755 --- a/doc/conf.py +++ b/doc/conf.py @@ -33,19 +33,9 @@ ] sphinx_gallery_conf = { - "examples_dirs": ["examples"], # path to - # example scripts - "gallery_dirs": ["auto_example"], - "filename_pattern": "/plot_", - "run_stale_examples": True, - "show_signature": False, - # directory where function/class granular galleries are stored - "backreferences_dir": "gen_modules/backreferences", - # Modules for which function/class level galleries are created. - "doc_module": ("openturns"), - # objects to exclude from implicit backreferences. The default option - # is an empty set, i.e. exclude nothing. - "exclude_implicit_doc": {}, + 'examples_dirs': ['examples'], + 'gallery_dirs': ['auto_examples'], + 'show_signature': False, } autodoc_default_options = { @@ -72,7 +62,7 @@ extensions.append("matplotlib.sphinxext.plot_directive") intersphinx_mapping = { - "python": ("http://openturns.github.io/openturns/1.18", "openturns-objects.inv") + "python": ("http://openturns.github.io/openturns/1.22", "openturns-objects.inv") } autosummary_generate = True @@ -91,7 +81,7 @@ # General information about the project. project = u"ottemplate" -copyright = u"2005-2023 Airbus-EDF-IMACS-ONERA-Phimeca" +copyright = u"2005-2024 Airbus-EDF-IMACS-ONERA-Phimeca" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. diff --git a/doc/examples/README.txt b/doc/examples/README.txt index e69de29..7d4d0aa 100644 --- a/doc/examples/README.txt +++ b/doc/examples/README.txt @@ -0,0 +1,2 @@ +Examples +======== \ No newline at end of file diff --git a/doc/examples/examples.rst b/doc/examples/examples.rst deleted file mode 100644 index 0d3d79c..0000000 --- a/doc/examples/examples.rst +++ /dev/null @@ -1,10 +0,0 @@ -Examples -======== - -This section illustrates how to use the template. - - - -.. toctree:: - - ../auto_example/plot_basic diff --git a/doc/examples/plot_basic.py b/doc/examples/plot_basic.py index 9dd1772..fa6ce7e 100644 --- a/doc/examples/plot_basic.py +++ b/doc/examples/plot_basic.py @@ -2,6 +2,7 @@ Example : Using ottemplatepython module --------------------------------------- """ + # %% # This example aims to illustrate how to use the module. diff --git a/doc/index.rst b/doc/index.rst index 97a2e83..1d50781 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,7 +8,7 @@ User documentation :maxdepth: 2 user_manual/user_manual - examples/examples + ../auto_examples/index.rst Developer guide --------------- diff --git a/doc/openturns-objects.inv b/doc/openturns-objects.inv index 1d760e8..861a2b7 100644 Binary files a/doc/openturns-objects.inv and b/doc/openturns-objects.inv differ