commit | f5d0b94af45f910417e50a6b5f286e987ff59761 | [log] [tgz] |
---|---|---|
author | Muhammad Taha Naveed <mtaha@apache.org> | Sat May 11 04:36:16 2024 +0500 |
committer | GitHub <noreply@github.com> | Fri May 10 16:36:16 2024 -0700 |
tree | 36b50e60060e1fe38d4e14d68def060acee29dd4 | |
parent | f81b6efcf0598a2f5deaa4214444b49b9b9c12d3 [diff] |
Add branch protection rules in .asf.yaml (#322) - All the PRs sent to master and new-web branch will now require atleast 1 approving review before merge.
This repository provides the source for the main website of The Apache AGE.
The link below contains the following Apache AGE project:
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.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.brew install python3 virtualenv texlive
sudo apt install python3 virtualenv texlive-latex-base texlive-latex-extra texlive-extra-utils
virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements.txt
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
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).