From 983110a37e5373724f9bf1a450f69d12daa865e5 Mon Sep 17 00:00:00 2001 From: micah johnson Date: Tue, 3 Oct 2023 07:12:25 -0600 Subject: [PATCH 1/5] Added in missing import --- study_lyte/plotting.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 From b2017ee2b4b80f817f46a64fb9f16b43f27b8651 Mon Sep 17 00:00:00 2001 From: micah johnson Date: Tue, 3 Oct 2023 07:18:45 -0600 Subject: [PATCH 2/5] Added rtd config --- .readthedocs.yaml | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..5eb61fe --- /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 From f12206c326302601b48f86a2e134ff644ce1bf1d Mon Sep 17 00:00:00 2001 From: micah johnson Date: Sat, 14 Oct 2023 07:30:04 -0600 Subject: [PATCH 3/5] Missing import for auto docs --- requirements_dev.txt | 2 ++ 1 file changed, 2 insertions(+) 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 From 9dc332645a5bca677b32b0515a4e9d2d7c007791 Mon Sep 17 00:00:00 2001 From: micah johnson Date: Sat, 14 Oct 2023 07:44:21 -0600 Subject: [PATCH 4/5] Added the rtd reqs .txt --- .readthedocs.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 5eb61fe..d53549f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -30,6 +30,6 @@ sphinx: # 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 +python: + install: + - requirements: ./requirements_dev.txt From 291e48d87722df8540d75dcad72df088d7495574 Mon Sep 17 00:00:00 2001 From: micah johnson Date: Sat, 14 Oct 2023 07:51:28 -0600 Subject: [PATCH 5/5] Pointing to the correct reqs for docs --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d53549f..f92bc93 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -32,4 +32,4 @@ sphinx: # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - requirements: ./requirements_dev.txt + - requirements: ./docs/requirements.txt