Skip to content

Commit

Permalink
Add docs README
Browse files Browse the repository at this point in the history
  • Loading branch information
simicd committed Feb 10, 2024
1 parent 3265e45 commit 71bfb99
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 1 deletion.
76 changes: 76 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<!---
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 action
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
cd docs
sphinx-build -M html source build
```

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

Preview the site on Linux by running this command.

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

## Release Process

This documentation is hosted at https://arrow.apache.org/datafusion/

When the PR is merged to the `main` branch of the DataFusion
repository, a [github workflow](https://github.com/apache/arrow-datafusion/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/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/blob/main/.asf.yaml),
which specifies the target as https://arrow.apache.org/datafusion/.
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Apache Arrow Flight SQL adapter for PostgreSQL'
project = 'Apache Arrow Flight SQL Adapter for PostgreSQL'
copyright = '2019-2024, Apache Software Foundation'
trademark = [
"Apache Arrow Flight, Arrow Flight, Apache, the Apache feather logo, and the Apache Arrow project logo",
Expand Down

0 comments on commit 71bfb99

Please sign in to comment.