Skip to content

Commit

Permalink
changes in the user guide index page
Browse files Browse the repository at this point in the history
  • Loading branch information
luisaFelixSalles committed Sep 16, 2024
1 parent 5f16ef4 commit cafd463
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
13 changes: 6 additions & 7 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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"
Expand Down Expand Up @@ -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 ---------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit cafd463

Please sign in to comment.