Skip to content

Commit

Permalink
Better integration of sphinx gallery
Browse files Browse the repository at this point in the history
Also update inv
  • Loading branch information
sofianehaddad authored and jschueller committed Mar 21, 2024
1 parent dd531a1 commit a7ee48d
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 26 deletions.
20 changes: 5 additions & 15 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand All @@ -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

Expand All @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions doc/examples/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Examples
========
10 changes: 0 additions & 10 deletions doc/examples/examples.rst

This file was deleted.

1 change: 1 addition & 0 deletions doc/examples/plot_basic.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Example : Using ottemplatepython module
---------------------------------------
"""

# %%
# This example aims to illustrate how to use the module.

Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ User documentation
:maxdepth: 2

user_manual/user_manual
examples/examples
../auto_examples/index.rst

Developer guide
---------------
Expand Down
Binary file modified doc/openturns-objects.inv
Binary file not shown.

0 comments on commit a7ee48d

Please sign in to comment.