Add example scripts to documentation (#4225)

Co-authored-by: Harry Mellor <hmellor@oxts.com>
This commit is contained in:
Harry Mellor
2024-04-22 17:36:54 +01:00
committed by GitHub
parent 1543680691
commit 3d925165f2
6 changed files with 80 additions and 1 deletions

View File

@@ -48,7 +48,7 @@ templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns: List[str] = []
exclude_patterns: List[str] = ["**/*.template.rst"]
# Exclude the prompt "$" when copying code
copybutton_prompt_text = r"\$ "
@@ -73,6 +73,13 @@ html_theme_options = {
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# Generate additional rst documentation here.
def setup(app):
from docs.source.generate_examples import generate_examples
generate_examples()
# Mock out external dependencies here.
autodoc_mock_imports = [
"cpuinfo",