Google Git
Sign in
apache / age-website / 51452807c1e5e105e5095505fe333c039913bc72
commit51452807c1e5e105e5095505fe333c039913bc72[log] [tgz]
authorMuhammad Taha Naveed <m.taha.naveed27@gmail.com>Mon Sep 08 20:14:24 2025 +0500
committerGitHub <noreply@github.com>Mon Sep 08 08:14:24 2025 -0700
treeedd5e9225074c4049f15da9f5dea5a92ad4a6e9e
parent3aab3b8ecb8733dc6b9da0d616512b2d0b6b0f66 [diff]
Update actions in build-documentation.yml (#349)

- Fixes CD issue reported here
  https://github.com/apache/age-website/actions/runs/17527933415
1 file changed
tree: edd5e9225074c4049f15da9f5dea5a92ad4a6e9e
  1. .github/
  2. docs/
  3. .asf.yaml
  4. .DS_Store
  5. .gitignore
  6. .markdownlint.json
  7. index.html
  8. README.md
  9. requirements.txt
  10. requirements_min.txt
README.md

This repository provides the source for the main website of The Apache AGE.

The link below contains the following Apache AGE project:

  • 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.
  • 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 :warning: 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).

  • Navigate to the root of the repository

  • Activate the virtual environment if not yet active

source venv/bin/activate
  • Build the documentation

    • From :warning: 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).