Skip to content
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.

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

docs: Add ASF attribution #186

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@
/package/*/apt/repositories/
/package/*/apt/tmp/
/package/docker/*.deb
/venv/
75 changes: 75 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<!---
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.
-->

# Arrow Flight SQL Adapter for PostgreSQL Documentation

This folder contains the source for the public documentation.
This is published to https://arrow.apache.org/flight-sql-postgresql/ by a GitHub Actions workflow
when changes are merged to the main branch.

## Dependencies

It's recommended to install build dependencies and build the documentation
inside a Python `venv`.

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 documentation dependencies
```bash
pip install -r docs/requirements.txt
```

## Build & Preview

Run the provided script to build the HTML pages.

```bash
rake doc:html
```

The HTML will be generated into a `doc/build` directory.

Preview the site on Linux by running this command.

```bash
firefox doc/build/index.html
```

## Release Process

This documentation is hosted at https://arrow.apache.org/flight-sql-postgresql/ .

When the PR is merged to the `main` branch of the Apache Arrow Flight SQL adapter for PostgreSQL
repository, a [GitHub Actions workflow](https://github.com/apache/arrow-flight-sql-postgresql/blob/main/.github/workflows/doc.yaml) which:

1. Builds the HTML content
2. Pushes the HTML content to the [`asf-site`](https://github.com/apache/arrow-flight-sql-postgresql/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-flight-sql-postgresql/blob/main/.asf.yaml),
which specifies the target as https://arrow.apache.org/flight-sql-postgresql/.
30 changes: 30 additions & 0 deletions doc/source/_templates/trademark.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!--
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.
-->
/* eslint-disable prettier/prettier */

{# Display the trademark information (which is defined in conf.py html_context). #}
{% if show_copyright and trademark %}
<p class="trademark">
<div class="footer-item">
{% for trademark_line in trademark %}
<p>{{ trademark_line }}</p>
{% endfor %}
</div>
</p>
{% endif %}
15 changes: 13 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,21 @@
import os
import pathlib
import re
from datetime import datetime

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Apache Arrow Flight SQL adapter for PostgreSQL'
copyright = '2022-2023, Apache Arrow Developers'
author = 'Apache Arrow Developers'
copyright = (f'2022-{datetime.now().year}, Apache Software Foundation\n',
"Apache Arrow Flight, Arrow Flight, Arrow Flight SQL, Apache, the Apache feather logo, and the Apache Arrow project logo",
"are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries."
)
trademark = [

]
author = 'Apache Software Foundation'

version = os.environ.get('VERSION')
if not version:
meson_build_path = pathlib.Path(__file__).parent / '../../meson.build'
Expand Down Expand Up @@ -96,12 +104,15 @@
],
'use_edit_page_button': True,
'show_nav_level': 2,
"footer_start": ["copyright"],
"footer_end": ["sphinx-version", "theme-version"]
}
html_context = {
'github_user': 'apache',
'github_repo': 'arrow-flight-sql-postgresql',
'github_version': 'main',
'doc_path': 'doc/source',
'trademark': trademark
}
html_static_path = ['_static']
html_favicon = "_static/favicon.ico"