Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,14 @@ extra:
name: EasyDiffraction Library Source Code on GitHub

# Jupyter notebooks
plugins:
- mkdocs-jupyter:
execute_ignore:
- 'quick*.ipynb'
- 'basic*.ipynb'
- 'advanced*.ipynb'
- 'cryst*.ipynb'
- 'pdf*.ipynb'
# - '*emcee*.ipynb' # Ignore notebooks with 'emcee' in the name from execution
#plugins:
# - mkdocs-jupyter:
# execute_ignore:
# - 'quick*.ipynb'
# - 'basic*.ipynb'
# - 'advanced*.ipynb'
# - 'cryst*.ipynb'
# - 'pdf*.ipynb'

##################
# Add new settings
Expand Down
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ docs = [
'pyyaml', # YAML parser
]
visualization = [
'darkdetect', # Detecting dark mode
'pandas', # Displaying tables in juptyer notebooks
'plotly<6.1.0', # Interactive plots. 0.6.0 => Empty charts in Jupyter notebooks ...
'py3Dmol', # Visualisation of crystal structures
'darkdetect', # Detecting dark mode
'pandas', # Displaying tables in juptyer notebooks
'plotly', # Interactive plots
'py3Dmol', # Visualisation of crystal structures
]

[project.urls]
Expand Down Expand Up @@ -115,7 +115,7 @@ source = 'versioningit' # Use versioningit to manage the version
[tool.versioningit.format]
distance = '{base_version}+d{distance}' # example: 0.5.8+d3, 1.2.3.post4+d2
dirty = '{base_version}' # example: 0.5.8, 1.2.3.post4
distance-dirty = '{base_version}+d{distance}' #
distance-dirty = '{base_version}+d{distance}' # see 1st example

# Configure how versioningit detects versions from Git
# - 'match' ensures it only considers tags starting with 'v'
Expand Down
10 changes: 2 additions & 8 deletions src/easydiffraction/plotting/plotters/plotter_plotly.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
display = None
HTML = None

from easydiffraction.utils.utils import is_github_ci
from easydiffraction.utils.utils import is_pycharm

from .plotter_base import SERIES_CONFIG
from .plotter_base import PlotterBase
Expand Down Expand Up @@ -111,13 +111,7 @@ def plot(

# Show the figure

# In GitHub CI builds (e.g., during Jupyter Book generation), avoid
#
# calling `fig.show()`
# because it can emit `application/vnd.plotly.v1+json` outputs that some toolchains warn about.
# Instead, convert the figure to HTML and display it directly.
# Use a regular Figure and show it
if not is_github_ci() or display is None or HTML is None:
if is_pycharm() or display is None or HTML is None:
fig.show(config=config)
else:
html_fig = pio.to_html(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@
# introduction to EasyScience, EasyDiffraction is built on that framework and
# offers a high-level interface focused specifically for diffraction analysis.
#
# This notebook is self-contained and designed for hands-on learning.
# For more advanced features and additional capabilities of the EasyDiffraction
# library, please see the official documentation:
# https://docs.easydiffraction.org/lib

# This notebook is self-contained and designed for hands-on learning.
# However, if you're interested in exploring more advanced features or learning
# about additional capabilities of the EasyDiffraction library, please refer to
Expand Down