From 50d0df36f1437d0ec57e90f1c238da2200e50d16 Mon Sep 17 00:00:00 2001 From: Jay Moran Date: Fri, 20 Sep 2024 23:22:27 -0700 Subject: [PATCH] Add deprecation warning --- docs/legacy/api.md | 7 +++++++ docs/legacy/citing.md | 7 +++++++ docs/legacy/contributing.md | 7 +++++++ docs/legacy/examples.md | 7 +++++++ docs/legacy/index.md | 7 +++++++ docs/legacy/installing.md | 7 +++++++ docs/legacy/related.md | 7 +++++++ docs/legacy/releases.md | 7 +++++++ docs/legacy/support.md | 7 +++++++ docs/legacy/using.md | 7 +++++++ docs/overrides/main.html | 8 -------- docs/scripts/build_mkdocs.sh | 2 -- mkdocs_legacy.yml | 6 +++++- 13 files changed, 75 insertions(+), 11 deletions(-) delete mode 100644 docs/overrides/main.html diff --git a/docs/legacy/api.md b/docs/legacy/api.md index 5c5d484e..614c810f 100644 --- a/docs/legacy/api.md +++ b/docs/legacy/api.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ # TPOT API ## Classification diff --git a/docs/legacy/citing.md b/docs/legacy/citing.md index 4d6c79e3..d82508eb 100644 --- a/docs/legacy/citing.md +++ b/docs/legacy/citing.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ # 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 index 776ef280..524ad427 100644 --- a/docs/legacy/contributing.md +++ b/docs/legacy/contributing.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ # 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 index 559315e4..0a9a01b7 100644 --- a/docs/legacy/examples.md +++ b/docs/legacy/examples.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ # 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 index 1052213f..63fde06f 100644 --- a/docs/legacy/index.md +++ b/docs/legacy/index.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+
diff --git a/docs/legacy/installing.md b/docs/legacy/installing.md index 59627308..9e905559 100644 --- a/docs/legacy/installing.md +++ b/docs/legacy/installing.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ # Installation TPOT is built on top of several existing Python libraries, including: diff --git a/docs/legacy/related.md b/docs/legacy/related.md index fd11d4c1..67f90174 100644 --- a/docs/legacy/related.md +++ b/docs/legacy/related.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ Other Automated Machine Learning (AutoML) tools and related projects: diff --git a/docs/legacy/releases.md b/docs/legacy/releases.md index 763a2cef..d5506378 100644 --- a/docs/legacy/releases.md +++ b/docs/legacy/releases.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ # Release Notes ## Version 0.12.0 diff --git a/docs/legacy/support.md b/docs/legacy/support.md index 7d8cfea5..63a70b1c 100644 --- a/docs/legacy/support.md +++ b/docs/legacy/support.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ 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 index e857220a..c5402a80 100644 --- a/docs/legacy/using.md +++ b/docs/legacy/using.md @@ -1,3 +1,10 @@ +
+ + ⚠️ Warning +

This is documentation for the legacy version of TPOT. For the latest version, click here.

+ +
+ # Using TPOT ## What to expect from AutoML software diff --git a/docs/overrides/main.html b/docs/overrides/main.html deleted file mode 100644 index 3cf182cf..00000000 --- a/docs/overrides/main.html +++ /dev/null @@ -1,8 +0,0 @@ -{% extends "base.html" %} - -{% block outdated %} - You're not viewing the latest version. - - Click here to go to latest. - -{% endblock %} \ No newline at end of file diff --git a/docs/scripts/build_mkdocs.sh b/docs/scripts/build_mkdocs.sh index 1464098e..323323c5 100644 --- 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 index a52df3cf..324f925d 100644 --- 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 Randal S. Olson and others at the University of Pennsylvania nav: