Merge pull request #134 from daltzctr/dev

Update dependencies and add global warning for deprecated devices

.github/workflows/CI.yml

@@ -13,7 +13,7 @@ jobs:
         cache: 'pip'
     - name: Install Python Dependencies
       run: |
-        pip install -r requirements.txt
+        pip install -r source/requirements.txt
     - name: Install LaTeX
       run: |
         sudo apt-get update
@@ -47,7 +47,7 @@ jobs:
         cache: 'pip'
     - name: Install Dependencies
       run: |
-        pip install -r requirements.txt
+        pip install -r source/requirements.txt
     - name: Check Links
       run: |
         make linkcheck

pyproject.toml

@@ -8,20 +8,19 @@ authors = []
 python = "^3.9"
 ablog = "==0.10.25"
 doc8 = "==0.11.1"
-docutils = "==0.17.0"
+docutils = "==0.20.1"
 fonttools = {version = "==4.33.3", extras = ["woff"]}
 latex = "==0.7.0"
-packaging = "==20.9"
-sphinx = "==4.5.0"
+packaging = "==24.1"
+sphinx = "==7.3.7"
 sphinx-hoverxref = "==1.0.1"
-sphinx-notfound-page = "==0.8.0"
-sphinx-panels = "==0.6.0"
-sphinx-rtd-theme = "==1.0.0"
-sphinx-tabs = "==3.3.1"
+sphinx-notfound-page = "==1.0.2"
+sphinx-rtd-theme = "==2.0.0"
+sphinx-tabs = "==3.4.5"
 sphinx-version-warning = "==1.1.2"
 sphinxcontrib-ghcontributors = "==0.2.3"
 sphinxcontrib-htmlhelp = "==2.0.0"
-sphinxcontrib-serializinghtml = "==1.1.5"
+sphinxcontrib-serializinghtml = "==1.1.10"
 sphinxcontrib-svg2pdfconverter = "==1.2.0"
 sphinxext-delta = "==0.2.0"
 sphinxext-linkcheckdiff = "==0.1.0"

readthedocs.yml

@@ -18,4 +18,4 @@ formats:
 
 python:
   install:
-  - requirements: requirements.txt
+  - requirements: source/requirements.txt

source/conf.py

@@ -65,6 +65,18 @@
     'sphinx.ext.autosectionlabel'
 ]
 
+rst_prolog = """
+.. warning:: 
+   
+   The following device objects are deprecated and will be removed from the Phoenix 5 library in 2025. Users are encouraged to migrate to the `Phoenix 6 library <https://v6.docs.ctr-electronics.com/>`__ for deprecated devices.
+   
+   .. raw:: html
+   
+      <p>
+      - Pigeon2<br/>
+      - TalonFX<br/>
+      </p>
+"""
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 templates_path = [ablog.get_html_templates_path()]
@@ -92,7 +104,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

source/requirements.txt

@@ -0,0 +1,68 @@
+ablog==0.10.25 ; python_version >= "3.9" and python_version < "4.0"
+alabaster==0.7.16 ; python_version >= "3.9" and python_version < "4.0"
+babel==2.15.0 ; python_version >= "3.9" and python_version < "4.0"
+brotli==1.1.0 ; platform_python_implementation == "CPython" and python_version >= "3.9" and python_version < "4.0"
+brotlicffi==1.1.0.0 ; platform_python_implementation != "CPython" and python_version >= "3.9" and python_version < "4.0"
+certifi==2024.7.4 ; python_version >= "3.9" and python_version < "4.0"
+cffi==1.16.0 ; platform_python_implementation != "CPython" and python_version >= "3.9" and python_version < "4.0"
+charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "4.0"
+colorama==0.4.6 ; python_version >= "3.9" and python_version < "4.0" and sys_platform == "win32"
+data==0.4 ; python_version >= "3.9" and python_version < "4.0"
+decorator==5.1.1 ; python_version >= "3.9" and python_version < "4.0"
+doc8==0.11.1 ; python_version >= "3.9" and python_version < "4.0"
+docutils==0.20.1 ; python_version >= "3.9" and python_version < "4.0"
+feedgen==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
+fonttools[woff]==4.33.3 ; python_version >= "3.9" and python_version < "4.0"
+funcsigs==1.0.2 ; python_version >= "3.9" and python_version < "4.0"
+future==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
+gitdb==4.0.11 ; python_version >= "3.9" and python_version < "4.0"
+gitpython==3.1.43 ; python_version >= "3.9" and python_version < "4.0"
+idna==3.7 ; python_version >= "3.9" and python_version < "4.0"
+imagesize==1.4.1 ; python_version >= "3.9" and python_version < "4.0"
+importlib-metadata==8.0.0 ; python_version >= "3.9" and python_version < "3.10"
+invoke==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
+jinja2==3.1.4 ; python_version >= "3.9" and python_version < "4.0"
+latex==0.7.0 ; python_version >= "3.9" and python_version < "4.0"
+lxml==5.2.2 ; python_version >= "3.9" and python_version < "4.0"
+markupsafe==2.1.5 ; python_version >= "3.9" and python_version < "4.0"
+packaging==24.1 ; python_version >= "3.9" and python_version < "4.0"
+pbr==6.0.0 ; python_version >= "3.9" and python_version < "4.0"
+pycparser==2.22 ; platform_python_implementation != "CPython" and python_version >= "3.9" and python_version < "4.0"
+pygments==2.18.0 ; python_version >= "3.9" and python_version < "4.0"
+python-dateutil==2.9.0.post0 ; python_version >= "3.9" and python_version < "4.0"
+requests==2.32.3 ; python_version >= "3.9" and python_version < "4.0"
+restructuredtext-lint==1.4.0 ; python_version >= "3.9" and python_version < "4.0"
+shutilwhich==1.1.0 ; python_version >= "3.9" and python_version < "4.0"
+six==1.16.0 ; python_version >= "3.9" and python_version < "4.0"
+smmap==5.0.1 ; python_version >= "3.9" and python_version < "4.0"
+snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
+sphinx-hoverxref==1.0.1 ; python_version >= "3.9" and python_version < "4.0"
+sphinx-notfound-page==1.0.2 ; python_version >= "3.9" and python_version < "4.0"
+sphinx-rtd-theme==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
+sphinx-tabs==3.4.5 ; python_version >= "3.9" and python_version < "4.0"
+sphinx-version-warning==1.1.2 ; python_version >= "3.9" and python_version < "4.0"
+sphinx==7.3.7 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-applehelp==1.0.8 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-devhelp==1.0.6 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-ghcontributors==0.2.3 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-htmlhelp==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-jquery==4.1 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-qthelp==1.0.7 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-serializinghtml==1.1.10 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-svg2pdfconverter==1.2.0 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-delta==0.2.0 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-linkcheckdiff==0.1.0 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-mimic==0.1.1 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-opengraph==0.4.1 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-presentations==0.2.2 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-rediraffe==0.2.5 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-remoteliteralinclude==0.3.0 ; python_version >= "3.9" and python_version < "4.0"
+sphinxext-toptranslators==0.1.2 ; python_version >= "3.9" and python_version < "4.0"
+stevedore==5.2.0 ; python_version >= "3.9" and python_version < "4.0"
+tempdir==0.7.1 ; python_version >= "3.9" and python_version < "4.0"
+tomli==2.0.1 ; python_version >= "3.9" and python_version < "3.11"
+urllib3==1.26.19 ; python_version >= "3.9" and python_version < "4.0"
+watchdog==4.0.1 ; python_version >= "3.9" and python_version < "4.0"
+zipp==3.19.2 ; python_version >= "3.9" and python_version < "3.10"
+zopfli==0.2.3 ; python_version >= "3.9" and python_version < "4.0"