Skip to content

Commit 9031914

Browse files
fix: Remove unneeded files
1 parent b1340b0 commit 9031914

File tree

6 files changed

+9
-155
lines changed

6 files changed

+9
-155
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ instance/
7070

7171
# Sphinx documentation
7272
doc/_build/
73+
*sg_execution_times.rst
74+
doc/source/examples
7375

7476
# PyBuilder
7577
.pybuilder/

doc/source/conf.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,32 +88,33 @@
8888

8989
# sphinx gallery options
9090
sphinx_gallery_conf = {
91-
9291
# path to your examples scripts
93-
"examples_dirs": ["../../examples"],
92+
"examples_dirs": ["../../examples/local_launcher/example_scripts"],
9493
# path where to save gallery generated examples
9594
"gallery_dirs": ["examples"],
96-
# Pattern to search for example files
95+
# Pattern to search for example files - match ALL .py files
9796
"filename_pattern": r"\.py",
97+
# Ignore pattern to exclude __init__.py
98+
"ignore_pattern": "flycheck*",
9899
# Remove the "Download all examples" button from the top level gallery
99100
"download_all_examples": False,
100101
# Sort gallery example by file name instead of number of lines (default)
101102
"within_subsection_order": "FileNameSortKey",
102103
# directory where function granular galleries are stored
103104
"backreferences_dir": None,
104-
# Modules for which function level galleries are created. In
105+
# Modules for which function level galleries are created.
105106
"doc_module": "ansys-tools-common",
106107
"image_scrapers": ("matplotlib",),
107-
"ignore_pattern": r"__init__\.py",
108108
"thumbnail_size": (350, 350),
109109
"copyfile_regex": r".*\.rst",
110+
"plot_gallery": False,
110111
}
111112

112-
113113
# numpydoc configuration
114114
numpydoc_show_class_members = False
115115
numpydoc_xref_param_type = True
116116

117+
117118
# Consider enabling numpydoc validation. See:
118119
# https://numpydoc.readthedocs.io/en/latest/validation.html#
119120
numpydoc_validate = True

doc/source/examples/index.rst

Lines changed: 0 additions & 53 deletions
This file was deleted.

doc/source/examples/local_launcher/index.rst

Lines changed: 0 additions & 22 deletions
This file was deleted.

doc/source/examples/local_launcher/sg_execution_times.rst

Lines changed: 0 additions & 37 deletions
This file was deleted.

doc/source/examples/sg_execution_times.rst

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)