docs: Add ASF attribution (#580)

* Add ASF attribution and update docs README

* Fix formatting

* Fix unit test

* Undo changes in functions & tests and requirements.txt

Author: simicd

docs/README.md

@@ -28,15 +28,31 @@ when changes are merged to the main branch.
 It's recommended to install build dependencies and build the documentation
 inside a Python `venv`.
 
-```bash
-python -m pip install -r requirements-310.txt
-```
+To prepare building the documentation run the following on the root level of the project:
+
+1. Set up virtual environment if it was not already created
+   ```bash
+   python3 -m venv venv
+   ```
+1. Activate virtual environment
+    ```bash
+    source venv/bin/activate
+    ```
+1. Install Datafusion's Python dependencies
+    ```bash
+    pip install -r requirements-310.txt
+    ```
+1. Install documentation dependencies
+    ```bash
+    pip install -r docs/requirements.txt
+    ```
 
 ## Build & Preview
 
 Run the provided script to build the HTML pages.
 
 ```bash
+cd docs
 ./build.sh
 ```
 
@@ -50,14 +66,15 @@ firefox build/html/index.html
 
 ## Release Process
 
-The documentation is served through the
-[arrow-site](https://github.com/apache/arrow-site/) repo. To release a new
-version of the docs, follow these steps:
-
-1. Run `./build.sh` inside `docs` folder to generate the docs website inside the `build/html` folder.
-2. Clone the arrow-site repo
-3. Checkout to the `asf-site` branch (NOT `master`)
-4. Copy build artifacts into `arrow-site` repo's `datafusion` folder with a command such as
-   - `cp -rT ./build/html/ ../../arrow-site/datafusion/` (doesn't work on mac)
-   - `rsync -avzr ./build/html/ ../../arrow-site/datafusion/`
-5. Commit changes in `arrow-site` and send a PR.
+This documentation is hosted at https://arrow.apache.org/datafusion-python/
+
+When the PR is merged to the `main` branch of the DataFusion
+repository, a [github workflow](https://github.com/apache/arrow-datafusion-python/blob/main/.github/workflows/docs.yaml) which:
+
+1. Builds the html content
+2. Pushes the html content to the [`asf-site`](https://github.com/apache/arrow-datafusion-python/tree/asf-site) branch in this repository.
+
+The Apache Software Foundation provides https://arrow.apache.org/,
+which serves content based on the configuration in
+[.asf.yaml](https://github.com/apache/arrow-datafusion-python/blob/main/.asf.yaml),
+which specifies the target as https://arrow.apache.org/datafusion-python/.

docs/requirements.txt

@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-sphinx==5.3.0
+sphinx
 pydata-sphinx-theme==0.8.0
 myst-parser
 maturin

docs/source/_templates/docs-sidebar.html

@@ -1,6 +1,6 @@
 
 <a class="navbar-brand" href="{{ pathto(master_doc) }}">
-  <img src="{{ pathto('_static/images/' + logo, 1) }}" class="logo" alt="logo">
+  <img src="{{ pathto('_static/images/DataFusion-Logo-Background-White.png', 1) }}" class="logo" alt="logo">
 </a>
 
 <form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">

docs/source/_templates/layout.html

@@ -3,3 +3,24 @@
 {# Silence the navbar #}
 {% block docs_navbar %}
 {% endblock %}
+
+<!--
+    Custom footer
+-->
+{% block footer %}
+<!-- Based on pydata_sphinx_theme/footer.html -->
+<footer class="footer mt-5 mt-md-0">
+  <div class="container">
+    {% for footer_item in theme_footer_items %}
+    <div class="footer-item">
+      {% include footer_item %}
+    </div>
+    {% endfor %}
+    <div class="footer-item">
+      <p>Apache Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow DataFusion project logo</p>
+      <p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
+    </div>
+  </div>
+</footer>
+
+{% endblock %}

docs/source/conf.py

@@ -33,9 +33,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Arrow DataFusion"
-copyright = "2022, Apache Software Foundation"
-author = "Arrow DataFusion Authors"
+project = "Apache Arrow DataFusion"
+copyright = "2019-2024, Apache Software Foundation"
+author = "Apache Software Foundation"
 
 
 # -- General configuration ---------------------------------------------------