Skip to content

MuhammadTahaNaveed/age-website

 
 

Repository files navigation

  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.

The link below contains the following Apache AGE project:

  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
brew install python3 virtualenv texlive
  • Ubuntu
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
virtualenv -p python3 venv
  • Activate the virtual environment
source venv/bin/activate
  • Install the python requirements
pip install -r requirements.txt
  • Build the documentation
    • From ⚠️ remote branches

      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

      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

source venv/bin/activate
  • Build the documentation
    • From ⚠️ remote branches

      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

      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).

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%