docs: include incubator disclaimer text as footer to api reference (a…

…pache#465)
Elssky · Oct 8, 2024 · 06d8389 · 06d8389
1 parent 8dbce99
commit 06d8389
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 5 deletions.
diff --git a/cpp/CMakeLists.txt b/cpp/CMakeLists.txt
@@ -54,6 +54,8 @@ if (ENABLE_DOCS OR BUILD_DOCS_ONLY)
     set(DOXYGEN_IN ${PROJECT_SOURCE_DIR}/Doxyfile)
     set(DOXYGEN_OUT ${CMAKE_BINARY_DIR}/Doxyfile.out)
     configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+    # Copy disclaimer_footer.html to the build directory
+    configure_file(${PROJECT_SOURCE_DIR}/disclaimer_footer.html ${CMAKE_BINARY_DIR}/disclaimer_footer.html COPYONLY)
     add_custom_target(docs
         COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
         WORKING_DIRECTORY ${CMAKE_BINARY_DIR}

diff --git a/cpp/Doxyfile b/cpp/Doxyfile
@@ -1184,7 +1184,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            =
+HTML_FOOTER            = disclaimer_footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of

diff --git a/cpp/disclaimer_footer.html b/cpp/disclaimer_footer.html
@@ -0,0 +1,33 @@
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+
+<!-- disclaimer_footer.html -->
+<footer style="text-align: center; font-size: 12px;">
+    <div>
+        <p>
+            Apache GraphAr is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+        </p>
+        <p>
+            Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. <br/>
+            Apache, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.
+        </p>
+    </div>
+</footer>
diff --git a/pyspark/template/module.html.jinja2 b/pyspark/template/module.html.jinja2
@@ -25,9 +25,15 @@
 
 {% block module_contents %}
 {{ super() }}
-<footer>
-Copyright © <script>document.write(new Date().getFullYear())</script>,
-The Apache Software Foundation. the names of Apache projects, and the feather logo are
-either registered trademarks or trademarks of the Apache Software Foundation.
+<footer style="text-align: center; font-size: 12px;">
+  <div>
+    <p>
+      Apache GraphAr is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+    </p>
+    <p>
+      Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. <br/>
+      Apache, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.
+    </p>
+  </div>
 </footer>
 {% endblock %}