Skip to content

docs: Add ASF attribution #580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andygrove merged 4 commits into from
Feb 11, 2024
Merged

docs: Add ASF attribution #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14e0c20
Add ASF attribution and update docs README
simicd Feb 7, 2024
e155d6e
Fix formatting
simicd Feb 8, 2024
ba61372
Fix unit test
simicd Feb 8, 2024
6a03d6a
Undo changes in functions & tests and requirements.txt
simicd Feb 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 31 additions & 14 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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/.
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/_templates/docs-sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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">
Expand Down
21 changes: 21 additions & 0 deletions docs/source/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
6 changes: 3 additions & 3 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Copy link
Copy Markdown
Contributor Author

@simicd simicd Feb 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the starting year remain 2022 or be 2019?

Copy link
Copy Markdown
Member

@andygrove andygrove Feb 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think 2019 is good, because that was when the project became part of Apache Arrow

author = "Apache Software Foundation"


# -- General configuration ---------------------------------------------------
Expand Down