Skip to content

Commit

Permalink
docs: modification of config to handle package reference correctly + …
Browse files Browse the repository at this point in the history
…default thumbnail
  • Loading branch information
henrich14 authored and avivace committed Oct 8, 2024
1 parent 42da053 commit 586f72d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
Binary file added docs/source/_static/default_thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 13 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
import os
import sys

sys.path.insert(0, os.path.abspath("../../src"))
sys.path.append(os.path.abspath("../../src"))

# -- Project information -----------------------------------------------------

project = "pybada"
author = "Your Name"
release = "0.1" # Replace with your project's version
project = "pyBADA"
author = "Henrich Glaser - Opitz"
release = "0.1.0" # Replace with your project's version

# -- General configuration ---------------------------------------------------

Expand All @@ -25,6 +25,15 @@
"examples_dirs": "../../examples", # Path to your example scripts
"gallery_dirs": "auto_examples", # Path where to save generated output
"filename_pattern": "^((?!skip_).)*$", # Only include scripts not starting with 'skip_'
"reset_modules_order": "after", # Reset modules after each example
"run_stale_examples": True, # Force re-execution of examples
"remove_config_comments": True, # Clean up the code blocks
"capture_repr": ("_repr_html_",),
"default_thumb_file": os.path.abspath(
os.path.join(
os.path.dirname(__file__), "_static", "default_thumbnail.png"
)
),
}

autosummary_generate = True
Expand Down

0 comments on commit 586f72d

Please sign in to comment.