Add deprecation warning

EpistasisLab · Sep 21, 2024 · 50d0df3 · 50d0df3
1 parent 1607551
commit 50d0df3
Show file tree

Hide file tree

Showing 13 changed files with 75 additions and 11 deletions.
diff --git a/docs/legacy/api.md b/docs/legacy/api.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 # TPOT API
 
 ## Classification

diff --git a/docs/legacy/citing.md b/docs/legacy/citing.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 # Citing TPOT
 
 If you use TPOT in a scientific publication, please consider citing at least one of the following papers:

diff --git a/docs/legacy/contributing.md b/docs/legacy/contributing.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 # Contribution Guide
 
 We welcome you to [check the existing issues](https://github.com/EpistasisLab/tpot/issues/) for bugs or enhancements to work on. If you have an idea for an extension to TPOT, please [file a new issue](https://github.com/EpistasisLab/tpot/issues/new) so we can discuss it.

diff --git a/docs/legacy/examples.md b/docs/legacy/examples.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 # Overview
 
 The following sections illustrate the usage of TPOT with various datasets, each

diff --git a/docs/legacy/index.md b/docs/legacy/index.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 <center>
 <img src="https://raw.githubusercontent.com/EpistasisLab/tpot/master/images/tpot-logo.jpg" width=300 />
 </center>

diff --git a/docs/legacy/installing.md b/docs/legacy/installing.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 # Installation
 
 TPOT is built on top of several existing Python libraries, including:

diff --git a/docs/legacy/related.md b/docs/legacy/related.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 Other Automated Machine Learning (AutoML) tools and related projects:
 
 <table>

diff --git a/docs/legacy/releases.md b/docs/legacy/releases.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 # Release Notes
 
 ## Version 0.12.0

diff --git a/docs/legacy/support.md b/docs/legacy/support.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 TPOT was developed in the [Computational Genetics Lab](http://epistasis.org/) at the [University of Pennsylvania](https://www.upenn.edu/) with funding from the [NIH](http://www.nih.gov/) under grant R01 AI117694. We are incredibly grateful for the support of the NIH and the University of Pennsylvania during the development of this project.
 
 The TPOT logo was designed by Todd Newmuis, who generously donated his time to the project.
diff --git a/docs/legacy/using.md b/docs/legacy/using.md
@@ -1,3 +1,10 @@
+<div style="border: 2px solid #f39c12; background-color: #fdf3e7; padding: 15px; border-radius: 5px; color: #c0392b; margin-bottom: 20px; font-family: Arial, sans-serif;">
+
+  <strong>⚠️ Warning</strong>  
+  <p>This is documentation for the legacy version of TPOT. For the latest version, <a href="../latest/" style="color: #2980b9; text-decoration: none; font-weight: bold;">click here</a>.</p>
+
+</div>
+
 # Using TPOT
 
 ## What to expect from AutoML software

diff --git a/docs/overrides/main.html b/docs/overrides/main.html
diff --git a/docs/scripts/build_mkdocs.sh b/docs/scripts/build_mkdocs.sh
@@ -40,14 +40,12 @@ theme:
   palette:
     # light mode
     - scheme: default
-      primary: teal
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
 
     # dark mode
     - scheme: slate
-      primary: teal
       toggle:
         icon: material/brightness-4
         name: Switch to light mode

diff --git a/mkdocs_legacy.yml b/mkdocs_legacy.yml
@@ -11,19 +11,20 @@ site_dir: target/legacy_site
 theme:
   name: material
   logo: assets/tpot-logo.jpg
-  custom_dir: docs/overrides
   features:
     - toc.integrate
     - navigation.top
   palette:
     # light mode
     - scheme: default
+      primary: grey
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
 
     # dark mode
     - scheme: slate
+      primary: grey
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
@@ -44,6 +45,9 @@ markdown_extensions:
   - pymdownx.snippets
   - pymdownx.superfences
 
+plugins:
+  - include-markdown
+
 copyright: Developed by <a href="http://www.randalolson.com">Randal S. Olson</a> and others at the University of Pennsylvania
 
 nav: