DOC: add a bit of docs

jklymak · jklymak · commit 2f144a8e49bf · 2021-02-07T08:53:10.000-08:00
diff --git a/_websiteutils/make_redirects_links.py b/_websiteutils/make_redirects_links.py
@@ -10,7 +10,7 @@
 import shutil
 
 """
-This script does two things that improve the website organization.
+This script does three things that improve the website organization.
 
 First, we used to host in the root of the webpage, but have now moved to
 ``/stable/``.  We do not want obsolete links to link to nothing (or that has
@@ -21,6 +21,9 @@
 Second, it changes the canonical link in each html file to the newest version
 found of the html file (including stable if its in the latest version.)
 
+Third, the script adds a new div to the top of all the old webpages with
+tag ``olddocs-message`` to warn users that the page is obsolete.  
+
 This script takes a while, and is destructive, so should probably be run on a
 branch and pushed as a PR so it can easily be reverted.
 """
