Fix copyright and build status in documentation

esrlabs · Oct 23, 2024 · 7737967 · 7737967
1 parent ca6a951
commit 7737967
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -5,14 +5,18 @@ They can be used individually, but are designed to be used together.
 
 ## Sphinx Documentation
 
-- **dox_style**: Standard configuration, theme enhancements and style checks.
-- **dox_util**: Convenience features for Sphinx documentations.
-- **dox_trace**: Specification directives to achieve traceability.
+- [dox_style](https://esrlabs.github.io/dox/dox_style):
+  Standard configuration, theme enhancements and style checks.
+- [dox_util](https://esrlabs.github.io/dox/dox_util):
+  Convenience features for Sphinx documentations.
+- [dox_trace](https://esrlabs.github.io/dox/dox_trace):
+  Specification directives to achieve traceability.
 
 These tools are written in Python.
 
 ## Writing Requirements
 
-- **Dim**: A light-weight requirements tool based on YAML files.
+- [Dim](https://esrlabs.github.io/dox/dim):
+  A light-weight requirements tool based on YAML files.
 
 This tool is written in Ruby.
diff --git a/dim/documentation/source/conf.py b/dim/documentation/source/conf.py
@@ -7,10 +7,7 @@
 
 project = "Dim"
 author = "Accenture"
-copyright = (
-    f"{datetime.now().year} Accenture. All rights reserved. "
-    f"Accenture proprietary and confidential material"
-)
+copyright = f"{datetime.now().year} Accenture"
 
 html_context = {"document_status_default": "Released", "data_classification_default": None}
 

diff --git a/documentation/Makefile b/documentation/Makefile
@@ -11,11 +11,15 @@ help:
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -W $(SPHINXOPTS) $(O)
 
+
+dist: export OFFICIAL_BUILD := 1
 dist: Makefile
+	@rm -rf "$(BUILDDIR)"
 	@ruby footer.rb
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" -W $(SPHINXOPTS) $(O)
 
 	@for tool in dox_style dox_util dox_trace dim ; do \
+		rm -rf ../$$tool/documentation/build ; \
 		ruby ../$$tool/documentation/footer.rb ; \
 		$(MAKE) -C ../$$tool/documentation html ; \
 		mkdir -p build/html/$$tool ; \

diff --git a/documentation/source/conf.py b/documentation/source/conf.py
@@ -7,10 +7,7 @@
 
 project = "Dox"
 author = "Accenture"
-copyright = (
-    f"{datetime.now().year} Accenture. All rights reserved. "
-    f"Accenture proprietary and confidential material"
-)
+copyright = f"{datetime.now().year} Accenture"
 
 version = "1.0.0"
 

diff --git a/dox_style/documentation/source/conf.py b/dox_style/documentation/source/conf.py
@@ -7,10 +7,7 @@
 
 project = "dox_style"
 author = "Accenture"
-copyright = (
-    f"{datetime.now().year} Accenture. All rights reserved. "
-    f"Accenture proprietary and confidential material"
-)
+copyright = f"{datetime.now().year} Accenture"
 
 global __version__
 exec(open(f"../../{project}/version.py", "r").read(), globals())
@@ -23,3 +20,5 @@
     "dox_style",
     "dox_util",
 ]
+
+dox_style_footer = "footer.yaml"
diff --git a/dox_trace/documentation/source/conf.py b/dox_trace/documentation/source/conf.py
@@ -7,10 +7,7 @@
 
 project = "dox_trace"
 author = "Accenture"
-copyright = (
-    f"{datetime.now().year} Accenture. All rights reserved. "
-    f"Accenture proprietary and confidential material"
-)
+copyright = f"{datetime.now().year} Accenture"
 
 global __version__
 exec(open(f"../../{project}/version.py", "r").read(), globals())

diff --git a/dox_util/documentation/source/conf.py b/dox_util/documentation/source/conf.py
@@ -7,10 +7,7 @@
 
 project = "dox_util"
 author = "Accenture"
-copyright = (
-    f"{datetime.now().year} Accenture. All rights reserved. "
-    f"Accenture proprietary and confidential material"
-)
+copyright = f"{datetime.now().year} Accenture"
 
 global __version__
 exec(open(f"../../{project}/version.py", "r").read(), globals())