Skip to contentSkip to conversation

Add a banner on the old documentation docs. Script to add banners to the old docs and outdated dunfell docs

PATCH Superseded Abongwa Bonalais Amahnui 3 participants 5 messages May 4, 2022 – May 11, 2022

v13 of 14 Superseded Latest is v14 →

lore
Share & tools
lore
#0 lore raw

PATCH v13 1/1 Add a banner on the old documentation docs. Script to add banners to the old docs and outdated dunfell docs

---
 scripts/docs_add_banner.py | 104 +++++++++++++++++++++++++++++++++++++
 scripts/run-docs-build     |   2 +
 2 files changed, 106 insertions(+)
 create mode 100644 scripts/docs_add_banner.py
scripts/docs_add_banner.py new file +104 -0
new file mode 100644
index 0000000..4b65664
@@ -0,0 +1,104 @@
+#!/usr/bin/env python3
+#
+# SPDX-License-Identifier: GPL-2.0-only
+#
+#Signed-off-by: Abongwa Bonalais Amahnui <[email protected]>
+#
+#
+# Script to add banners to the old docs and outdated dunfell docs
+#
+#
+
+
+import os
+
+
+
+html_content_dunfell = '''
+<div id="outdated-warning">This document is outdated, you should select the <a href="https://docs.yoctoproject.org/dunfell">latest release version</a> in this series.</div>
+<div xml:lang="en" class="body" lang="en">
+'''
+html_content = '''
+<div id="outdated-warning">This version of the project is now considered obsolete, please select and use a <a href="https://docs.yoctoproject.org">more recent version</a>.</div>
+<div xml:lang="en" class="body" lang="en">
+'''
+
+# the class body and the last_div are used to make sure any .body property existing in any css file is not overwritten
+last_div = '''
+</div>
+
+'''
+
+css_replacement_content = '''
+ 
+  font-family: Verdana, Sans, sans-serif;
+
+  width: 100%;
+  margin:  0;
+  padding: 0;
+  color: #333;
+  overflow-x: hidden;
+  }
+ 
+.body{
+margin:  0 auto;
+min-width: 640px;
+padding: 0 5em 5em 5em;
+}
+#outdated-warning{
+text-align: center;
+background-color: rgb(255, 186, 186); 
+color: rgb(106, 14, 14); 
+padding: 0.5em 0; 
+width: 100%;
+position: fixed;
+top: 0;
+
+
+'''
+
+def add_banner_old_docs(dir):
+    exclude = []
+    for root, dirs, filenames in os.walk(dir):
+         # exclude banner for 3.1.x upward as it is an LTS release and is still supported
+        exclude = [ name for name in os.listdir(dir) if name.startswith('3.1') ]
+        for d in dirs:
+            if d in exclude:
+                dirs.remove(d)
+        for filename in filenames:
+            if filename.endswith('.html'):
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    current_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:
+                    f.write(current_content.replace('<body>', '<body>' + html_content))
+                    f.write(current_content.replace('</body>', last_div + '</body>'))
+            if filename.endswith('.css'):
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    css_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:
+                    f.write(css_content.replace(css_content[css_content.find('body {'):css_content.find('}'[0])], 'body {' + css_replacement_content ))
+add_banner_old_docs('.')
+
+
+
+
+def dunfell_docs(dir):
+    dunfell_banners = []
+    for root, dirs, filenames in os.walk(dir):
+        dunfell_banners = [ name for name in os.listdir(dir) if not name.startswith('3.1') ]
+        for d in dirs:
+            if d in dunfell_banners:
+                dirs.remove(d)
+        for filename in filenames:
+            if filename.endswith('.html'):
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    current_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:
+                    f.write(current_content.replace('<body>', '<body>' + html_content_dunfell))
+                    f.write(current_content.replace('</body>', last_div + '</body>'))
+            if filename.endswith('.css'):
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    css_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:
+                    f.write(css_content.replace(css_content[css_content.find('body {'):css_content.find('}'[0])], 'body {' + css_replacement_content ))
+dunfell_docs('.')
\ No newline at end of file
scripts/run-docs-build +2 -0
index ecc5332..307ac19 100755
@@ -37,6 +37,8 @@ cd $outputdir
 echo Extracing old content from archive
 tar -xJf $docbookarchive
 
+$scriptdir/docs_fix_all_html_css.py
+
 cd $bbdocs
 mkdir $outputdir/bitbake
 
Signature · 1 line
2.25.1
#1 lore raw
Quoted 5 lines · Abongwa Amahnui Bonalais
scripts/docs_add_banner.py new file +4 -0
+
+def add_banner_old_docs(dir):
+    exclude = []
+    for root, dirs, filenames in os.walk(dir):

scripts/docs_add_banner.py line 72

Quoted 10 lines
scripts/docs_add_banner.py new file +10 -0
+         # exclude banner for 3.1.x upward as it is an LTS release and is still supported
+        exclude = [ name for name in os.listdir(dir) if name.startswith('3.1') ]
+        for d in dirs:
+            if d in exclude:
+                dirs.remove(d)
+        for filename in filenames:
+            if filename.endswith('.html'):
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    current_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:

This is definitely getting there, thanks!

One small thing, shouldn't we write the files with the same encoding as we read them?

Quoted 21 lines
scripts/docs_add_banner.py new file +21 -0
+                    f.write(current_content.replace('<body>', '<body>' + html_content))
+                    f.write(current_content.replace('</body>', last_div + '</body>'))
+            if filename.endswith('.css'):
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    css_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:
+                    f.write(css_content.replace(css_content[css_content.find('body {'):css_content.find('}'[0])], 'body {' + css_replacement_content ))
+add_banner_old_docs('.')
+
+
+
+
+def dunfell_docs(dir):
+    dunfell_banners = []
+    for root, dirs, filenames in os.walk(dir):
+        dunfell_banners = [ name for name in os.listdir(dir) if not name.startswith('3.1') ]
+        for d in dirs:
+            if d in dunfell_banners:
+                dirs.remove(d)
+        for filename in filenames:
+            if filename.endswith('.html'):

scripts/docs_add_banner.py line 103

Quoted 10 lines
scripts/docs_add_banner.py new file +10 -0
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    current_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:
+                    f.write(current_content.replace('<body>', '<body>' + html_content_dunfell))
+                    f.write(current_content.replace('</body>', last_div + '</body>'))
+            if filename.endswith('.css'):
+                with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f:
+                    css_content = f.read()
+                with open(os.path.join(root, filename), 'w') as f:
+                    f.write(css_content.replace(css_content[css_content.find('body {'):css_content.find('}'[0])], 'body {' + css_replacement_content ))

I think Quentin also mentioned that these two loop functions can be merged together to form simpler code with a condition in the centre section?

Quoted 2 lines

+dunfell_docs('.')
\ No newline at end of file

We can add a newline at the end to avoid that.

Cheers,

Richard

#2 lore raw

Hello Richard,

Thanks for the review

Quoted 3 lines

I think Quentin also mentioned that these two loop functions can be merged together to form simpler code with a condition in the centre section?

I'm sorry I don't understand how to implement this as I tried using a function in the code but then the dirs was modified constantly when it was not supposed and I did not succeed to prevent it from doing so. I will continue doing more research on how to go about it, but if you have a method you would like me to use, I would gladly try it out.
Thank you.

#3 lore raw

Hi Amahnui,

Quoted 5 lines · Abongwa Amahnui Bonalais

Hello Richard,

Thanks for the review

Quoted 1 line
Quoted 7 lines
Quoted 2 lines

I think Quentin also mentioned that these two loop functions can be merged together to form simpler code with a condition in the centre section?

I'm sorry I don't understand how to implement this as I tried using a function in the code but then the dirs was modified constantly when it was not supposed and I did not succeed to prevent it from doing so. I will continue doing more research on how to go about it, but if you have a method you would like me to use, I would gladly try it out.
Thank you.

In pseudo-code:

html_banner_dunfell = "this"
html_banner_not_dunfell = "that"
css_banner = "something"

for directory, files in recursive_traversal(path):
if matches(directory, '3.1*'):
html_banner = html_banner_dunfell
else
html_banner = html_banner_not_dunfell
for file in files:
if matches(file, '*.html'):
replace(content(file), html_banner)
else if matches(file, '*.css'):
replace(content(file), css_banner)

In v12 I commented the following code if you need something closer to proper Python code:

def add_banner_old_docs(dir):
for root, dirs, filenames in os.walk(dir):
if root.startswith('./3.1'):
html_replacement = html_content_dunfell
else:
html_replacement = html_content

for filename in filenames:
if filename.endswith('.html'):
with open(os.path.join(root, filename), 'r',
encoding="ISO-8859-1") as f:
current_content = f.read()
with open(os.path.join(root, filename), 'w') as f:
f.write(current_content.replace('<body>', '<body>'
+ html_replacement)) f.write(current_content.replace('</body>', last_div '</body>'))
if filename.endswith('.css'):
with open(os.path.join(root, filename), 'r',
encoding="ISO-8859-1") as f:
css_content = f.read()
with open(os.path.join(root, filename), 'w') as f:

f.write(css_content.replace(css_content[css_content.find('body {'):css_content.find('}'[0])], 'body {' + css_replacement_content ))

add_banner_old_docs('.')

Not tested of course, but hopefully that helps you understand what I meant with factoring out the code into one function only.

Cheers,
Quentin

#4 lore raw
In reply to Richard Purdie
Quoted 4 lines · Richard Purdie

One small thing, shouldn't we write the files with the same encoding as we read
them?

thank you for this, I adjusted it the most recent patch

Quoted 32 lines · Abongwa Amahnui Bonalais

Hello Richard,
Thanks for the review

Quoted 3 lines

I think Quentin also mentioned that these two loop functions can be merged

together to form simpler code with a condition in the centre section?

I'm sorry I don't understand how to implement this as I tried using a function in the code but then the dirs was modified constantly when it was not supposed and I did not succeed to prevent it from doing so. I will continue doing more research on how to go about it, but if you have a method you would like me to use, I would gladly try it out. Thank you.

In pseudo-code: html_banner_dunfell = "this" html_banner_not_dunfell = "that" css_banner = "something" for directory, files in recursive_traversal(path): if matches(directory, '3.1*'): html_banner = html_banner_dunfell else html_banner = html_banner_not_dunfell for file in
files: if matches(file, '*.html'): replace(content(file), html_banner) else if matches(file, '*.css'): replace(content(file), css_banner) In v12 I commented the following code if you need something closer to proper Python
code: def add_banner_old_docs(dir): for root, dirs, filenames in os.walk(dir): if root.startswith('./3.1'): html_replacement = html_content_dunfell else: html_replacement = html_content for filename in
filenames: if filename.endswith('.html'): with open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f: current_content = f.read() with

Quoted 8 lines

open(os.path.join(root, filename), 'w') as f: f.write(current_content.replace('<body>',
'<body>' + html_replacement)) f.write(current_content.replace('</body>',
last_div '</body>')) if filename.endswith('.css'): with
open(os.path.join(root, filename), 'r', encoding="ISO-8859-1") as f: css_content
= f.read() with open(os.path.join(root, filename), 'w') as f: f.write(css_content.replace(css_content[css_content.find('body {'):css_content.find('}'[0])], 'body {' + css_replacement_content )) add_banner_old_docs('.')
Not tested of course, but hopefully that helps you understand what I meant
with factoring out the code into one function only.

Thank you very much, I implemented this and  I worked.