Convert .hidden to a File

Author: guyer

.github/workflows/Docs4NIST.yml

@@ -12,3 +12,4 @@ jobs:
           formats: |-
            epub
            pdf
+          hidden: true

ntd2d/ntd2d_action/files/__init__.py

@@ -5,6 +5,7 @@
 from .borgedconffile import BorgedConfFile
 from .conffile import ConfFile
 from .cssfile import CSSFile
+from .hiddenfile import HiddenFile
 from .indexfile import IndexFile
 from .menufile import MenuFile
 from .nojekyllfile import NoJekyllFile

ntd2d/ntd2d_action/files/hiddenfile.py

@@ -0,0 +1,12 @@
+from .file import File
+
+
+class HiddenFile(File):
+    # Add a file that indicates docs should not be included in variant menu
+    
+    def __init__(self, html_dir):
+        self.html_dir = html_dir
+
+    @property
+    def path(self):
+        return self.html_dir / ".hidden"

ntd2d/ntd2d_action/repository.py

@@ -6,7 +6,7 @@
 import github_action_utils as gha_utils
 import pathlib
 
-from .files import NoJekyllFile
+from .files import NoJekyllFile, HiddenFile
 from .variants import Variant, VariantCollector
 
 class Repository:
@@ -102,7 +102,7 @@ def update_pages(self, branch, sha, hidden=False):
         gha_utils.debug(f"Variant {variant.name}", use_subprocess=True)
 
         if hidden:
-            (self.docs.html_dir / ".hidden").touch()
+            HiddenFile(html_dir=self.docs.html_dir).write()
 
         variant.copy_html(src=self.docs.html_dir)
         variant.copy_download_file(src=self.docs.epub_file, kind="ePUB")