diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..853495c --- /dev/null +++ b/doc/README.md @@ -0,0 +1,76 @@ + + +# 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/flight-sql-postgresql/ + +When the PR is merged to the `main` branch of the DataFusion +repository, a [github 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/. diff --git a/doc/source/conf.py b/doc/source/conf.py index 7df49b5..e8dcab5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,12 +22,13 @@ 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 = '2019-2024, Apache Software Foundation' +project = 'Apache Arrow Flight SQL Adapter for PostgreSQL' +copyright = f'2019-{datetime.now().year}, Apache Software Foundation' trademark = [ "Apache Arrow Flight, Arrow Flight, 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."