https://github.com/apache/age-website
AGE Project
https://github.com/apache/age-website
age
Last synced: 9 months ago
JSON representation
AGE Project
- Host: GitHub
- URL: https://github.com/apache/age-website
- Owner: apache
- Created: 2020-07-01T06:20:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T21:30:19.000Z (over 1 year ago)
- Last Synced: 2025-03-29T15:07:06.264Z (over 1 year ago)
- Topics: age
- Language: HTML
- Homepage: https://age.apache.org
- Size: 328 MB
- Stars: 38
- Watchers: 15
- Forks: 64
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/run_tests.md
Awesome Lists containing this project
README
Apache AGE website
is a leading multi-model graph database
Graph Processing & Analytics for Relational Databases
This repository provides the source for the main [website of The Apache AGE](https://age.apache.org/).
The link below contains the following Apache AGE project:
* [The Apache AGE Project](https://github.com/apache/age)
* [The Apache AGE Viewer Project](https://github.com/apache/age-viewer)
Introduction
* The `master` branch contains the source code of the latest version of the documentation.
* `vX.Y.Z` Branches contain the source code of the documentation of releases.
* The `asf-site` branch contains the static webpage code, as well as the build static version of the documenation (in the `docs` folder). The `docs` folder should not be manually updated.
* `new-web` branch is where website development work is done.
Build the documentation locally (first time)
* Install requirements (the latex and dvisvgm commands are required to display math)
- **MacOS**
```shell
brew install python3 virtualenv texlive
```
- **Ubuntu**
```shell
sudo apt install python3 virtualenv texlive-latex-base texlive-latex-extra texlive-extra-utils
```
* Clone this repository
* Navigate to the root of the repository
* Create a python virtual environment
```shell
virtualenv -p python3 venv
```
* Activate the virtual environment
```shell
source venv/bin/activate
```
* Install the python requirements
```shell
pip install -r requirements.txt
```
* Build the documentation
* From :warning: remote branches
```shell
sphinx-multiversion docs build/html
```
The documentation should now be in the `build/html` folder, with a subfolder per remote branch (version).
* From the current folder
```shell
sphinx-build docs build/html/current
```
The documentation for the current local branch should now be in the `build/html/current` folder (no subfolders).
Build documentation locally (after initial setup)
* Navigate to the root of the repository
* Activate the virtual environment if not yet active
```shell
source venv/bin/activate
```
* Build the documentation
* From :warning: remote branches
```shell
sphinx-multiversion docs build/html
```
The documentation should now be in the `build/html` folder, with a subfolder per remote branch (version).
* From the current folder
```shell
sphinx-build docs build/html/current
```
The updated documentation for the current local branch should now be in the `build/html/current` folder (no subfolders).