From cafd463349c69b59c99fea09b757691f8b0e3106 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Mon, 16 Sep 2024 15:40:31 +0200 Subject: [PATCH] changes in the user guide index page --- doc/source/conf.py | 13 ++++++------- src/ansys/dpf/core/config.py | 2 +- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index dec2b2f776..5014a6aaf5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -108,7 +108,7 @@ autodoc_mock_imports = ["ansys.dpf.core.examples.python_plugins"] -# Add any paths that contain _templates here, relative to this directory. +# Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] # The suffix(es) of source filenames. @@ -165,7 +165,7 @@ def reset_servers(gallery_conf, fname, when): # convert rst to md for ipynb "pypandoc": True, # path to your examples scripts - "examples_dirs": ["../../examples" ], + "examples_dirs": ["../../examples"], # abort build at first example error 'abort_on_example_error': True, # path where to save gallery generated examples @@ -179,8 +179,7 @@ def reset_servers(gallery_conf, fname, when): # Sort gallery example by file name instead of number of lines (default) "within_subsection_order": FileNameSortKey, # directory where function granular galleries are stored - # "backreferences_dir": "gen_modules/backreferences", - # 'doc_module': 'src', + "backreferences_dir": None, "image_scrapers": ("pyvista", "matplotlib"), # 'first_notebook_cell': ("%matplotlib inline\n" # "from pyvista import set_plot_theme\n" @@ -229,17 +228,17 @@ def reset_servers(gallery_conf, fname, when): 'custom.css', ] -# Custom sidebar _templates, must be a dictionary that maps document names +# Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these _templates by +# defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} -html_sidebars = {"testing": [] } +html_sidebars = {"testing": []} # -- Options for HTMLHelp output --------------------------------------------- diff --git a/src/ansys/dpf/core/config.py b/src/ansys/dpf/core/config.py index 9ea8b87d0c..549851392b 100644 --- a/src/ansys/dpf/core/config.py +++ b/src/ansys/dpf/core/config.py @@ -20,7 +20,7 @@ class Config: """Represents an operator's configuration. You can use configurations to choose how an operator will run. - This is an 00-dvanced feature for deep customization. + This is an advanced feature for deep customization. The different options can change the way loops are done. They can also change whether the operator needs to perform checks on the input.