🔧 FIX: docs build

.readthedocs.yaml

@@ -33,6 +33,6 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - develop
+        - dev
 
 formats: []

docs/autoapi/piel/visual/auto_plot_multiple/index.rst

@@ -18,18 +18,26 @@ Functions
 
 
 
-.. py:function:: plot_simple(x_data: numpy.array, y_data: numpy.array, ylabel: str, xlabel: str)
+.. py:function:: plot_simple(x_data: numpy.array, y_data: numpy.array, label: str | None = None, ylabel: str | None = None, xlabel: str | None = None, fig: matplotlib.pyplot.Figure | None = None, ax: matplotlib.pyplot.Axes | None = None, *args, **kwargs)
 
-   Plot a simple line graph.
+   Plot a simple line graph. The desire of this function is just to abstract the most basic data representation whilst
+   keeping the flexibility of the matplotlib library. The goal would be as well that more complex data plots can be
+   constructed from a set of these methods.
 
    :param x_data: X axis data.
    :type x_data: np.array
    :param y_data: Y axis data.
    :type y_data: np.array
-   :param ylabel: Y axis label.
-   :type ylabel: str
-   :param xlabel: X axis label.
-   :type xlabel: str
+   :param label: Label for the plot. Defaults to None.
+   :type label: str, optional
+   :param ylabel: Y axis label. Defaults to None.
+   :type ylabel: str, optional
+   :param xlabel: X axis label. Defaults to None.
+   :type xlabel: str, optional
+   :param fig: Matplotlib figure. Defaults to None.
+   :type fig: plt.Figure, optional
+   :param ax: Matplotlib axes. Defaults to None.
+   :type ax: plt.Axes, optional
 
    :returns: Matplotlib plot.
    :rtype: plt

docs/autoapi/piel/visual/index.rst

@@ -12,6 +12,7 @@ Submodules
 
    auto_plot_multiple/index.rst
    data_conversion/index.rst
+   style/index.rst
 
 
 Package Contents
@@ -27,21 +28,30 @@ Functions
    piel.visual.plot_simple_multi_row
    piel.visual.append_row_to_dict
    piel.visual.points_to_lines_fixed_transient
+   piel.visual.activate_piel_styles
 
 
 
-.. py:function:: plot_simple(x_data: numpy.array, y_data: numpy.array, ylabel: str, xlabel: str)
+.. py:function:: plot_simple(x_data: numpy.array, y_data: numpy.array, label: str | None = None, ylabel: str | None = None, xlabel: str | None = None, fig: matplotlib.pyplot.Figure | None = None, ax: matplotlib.pyplot.Axes | None = None, *args, **kwargs)
 
-   Plot a simple line graph.
+   Plot a simple line graph. The desire of this function is just to abstract the most basic data representation whilst
+   keeping the flexibility of the matplotlib library. The goal would be as well that more complex data plots can be
+   constructed from a set of these methods.
 
    :param x_data: X axis data.
    :type x_data: np.array
    :param y_data: Y axis data.
    :type y_data: np.array
-   :param ylabel: Y axis label.
-   :type ylabel: str
-   :param xlabel: X axis label.
-   :type xlabel: str
+   :param label: Label for the plot. Defaults to None.
+   :type label: str, optional
+   :param ylabel: Y axis label. Defaults to None.
+   :type ylabel: str, optional
+   :param xlabel: X axis label. Defaults to None.
+   :type xlabel: str, optional
+   :param fig: Matplotlib figure. Defaults to None.
+   :type fig: plt.Figure, optional
+   :param ax: Matplotlib axes. Defaults to None.
+   :type ax: plt.Axes, optional
 
    :returns: Matplotlib plot.
    :rtype: plt
@@ -119,3 +129,10 @@ Functions
    :returns: Dataframe or dictionary of data with steady-state lines.
 
 
+.. py:function:: activate_piel_styles()
+
+   Activates the piel fast rc params.
+
+   :returns: None
+
+

docs/sections/environment/installation.rst

@@ -43,6 +43,12 @@ Once you have a copy of the source, you can install it with:
 
    $ pip install -e .
 
+You can install our exact supported dependencies in a poetry-managed environment by:
+
+.. code:: console
+
+   $ poetry instal
+
 Developer’s Requirements
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -53,7 +59,7 @@ documentation, and full environment:
 
    mamba install pandoc
    mamba install jupyterlab jupytext
-   pip install -r requirements_dev.txt
+   poetry install -E dev
 
 Usage
 -----

piel/cli/develop.py

@@ -16,7 +16,8 @@ def develop():
 def build_documentation(args=None):
     """Verifies and builds the documentation."""
     # Runs the documentation build from the poetry environment
-    echo_and_check_subprocess(["poetry", "run", "python", "-m", "sphinx", "docs/", "_docs/"])
+    # TODO fix this so it runs from poetry.
+    echo_and_check_subprocess(["python", "-m", "sphinx", "docs/", "_docs/"])
     return 0