diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..f92bc93 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.9" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: ./docs/requirements.txt diff --git a/requirements_dev.txt b/requirements_dev.txt index 077554a..ba72e91 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -12,3 +12,5 @@ pytest==6.2.4 matplotlib nbconvert coverage +sphinxcontrib.apidoc +nbsphinx \ No newline at end of file diff --git a/study_lyte/plotting.py b/study_lyte/plotting.py index 6f6011c..7633b7a 100644 --- a/study_lyte/plotting.py +++ b/study_lyte/plotting.py @@ -1,5 +1,6 @@ import matplotlib.pyplot as plt -from study_lyte.styles import EventStyle +from .styles import EventStyle + def plot_events(ax, profile_events, plot_type='normal', event_alpha=0.6): """ Plots the hline or vline for each event on a plot