Google Git
Sign in
apache / age-website / refs/heads/master
commit4d47f18e97e8269a89ddd0a9863f8361a2b542a2[log] [tgz]
authordpdjvhxm <137974842+dpdjvhxm@users.noreply.github.com>Thu Apr 18 17:30:24 2024 +0900
committerGitHub <noreply@github.com>Thu Apr 18 17:30:24 2024 +0900
treeb9ba0b5a0090ff608979cf295d37ab2f0fcd9d42
parent34590d20d08fd89e13d2cfffd1243f97525ccb9b [diff]
Update Readme (#309)

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
1 file changed
tree: b9ba0b5a0090ff608979cf295d37ab2f0fcd9d42
  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).