Merge pull request #278 from chieto-arista/add_required_config

Added required yaml documentation

.readthedocs.yaml

@@ -0,0 +1,36 @@
+# 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.11"
+    # 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:
+   - htmlzip
+
+# 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: dev-requirements.txt
+    - method: pip
+      path: .

MANIFEST.in

@@ -4,6 +4,7 @@ include .coveragerc
 include LICENSE
 include Makefile
 include VERSION
+include *.yaml
 recursive-include examples *.conf
 recursive-include examples *.py
 recursive-include test *.conf

pyeapi/utils.py

@@ -245,13 +245,13 @@ class CliVariants:
     """
     @staticmethod
     def expand( cmds ):
-        """ Expands cmds argument into a list of all CLI variants 
-        
+        """ Expands cmds argument into a list of all CLI variants
+
         The method returns a list of all full variant combinations present
         in the the cmds arguement
 
         Args:
-            cmds (list): a list made of str and CliVariants types 
+            cmds (list): a list made of str and CliVariants types
 
         Returns:
             expanded list, e.g.: