Skip to content

Commit 71bfb99

Browse files
committed
Add docs README
1 parent 3265e45 commit 71bfb99

File tree

2 files changed

+77
-1
lines changed

2 files changed

+77
-1
lines changed

doc/README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!---
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Arrow Flight SQL Adapter for PostgreSQL Documentation
21+
22+
This folder contains the source for the public documentation.
23+
This is published to https://arrow.apache.org/flight-sql-postgresql/ by a GitHub action
24+
when changes are merged to the main branch.
25+
26+
## Dependencies
27+
28+
It's recommended to install build dependencies and build the documentation
29+
inside a Python `venv`.
30+
31+
To prepare building the documentation run the following on the root level of the project:
32+
33+
1. Set up virtual environment if it was not already created
34+
```bash
35+
python3 -m venv venv
36+
```
37+
1. Activate virtual environment
38+
```bash
39+
source venv/bin/activate
40+
```
41+
1. Install documentation dependencies
42+
```bash
43+
pip install -r docs/requirements.txt
44+
```
45+
46+
## Build & Preview
47+
48+
Run the provided script to build the HTML pages.
49+
50+
```bash
51+
cd docs
52+
sphinx-build -M html source build
53+
```
54+
55+
The HTML will be generated into a `build` directory.
56+
57+
Preview the site on Linux by running this command.
58+
59+
```bash
60+
firefox build/html/index.html
61+
```
62+
63+
## Release Process
64+
65+
This documentation is hosted at https://arrow.apache.org/datafusion/
66+
67+
When the PR is merged to the `main` branch of the DataFusion
68+
repository, a [github workflow](https://github.com/apache/arrow-datafusion/blob/main/.github/workflows/docs.yaml) which:
69+
70+
1. Builds the html content
71+
2. Pushes the html content to the [`asf-site`](https://github.com/apache/arrow-datafusion/tree/asf-site) branch in this repository.
72+
73+
The Apache Software Foundation provides https://arrow.apache.org/,
74+
which serves content based on the configuration in
75+
[.asf.yaml](https://github.com/apache/arrow-datafusion/blob/main/.asf.yaml),
76+
which specifies the target as https://arrow.apache.org/datafusion/.

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# -- Project information -----------------------------------------------------
2727
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
2828

29-
project = 'Apache Arrow Flight SQL adapter for PostgreSQL'
29+
project = 'Apache Arrow Flight SQL Adapter for PostgreSQL'
3030
copyright = '2019-2024, Apache Software Foundation'
3131
trademark = [
3232
"Apache Arrow Flight, Arrow Flight, Apache, the Apache feather logo, and the Apache Arrow project logo",

0 commit comments

Comments
 (0)