commit | 92b836a8e98f990065826cf8b70c6a511fd79e70 | [log] [tgz] |
---|---|---|
author | Bhaskar Sharma <bhaskarsharma2175@edu.bme.hu> | Mon Mar 13 07:17:46 2023 +0100 |
committer | GitHub <noreply@github.com> | Mon Mar 13 15:17:46 2023 +0900 |
tree | 4f23154684eeb0a1c445cf2e797fedc21af4db8e | |
parent | 7c6e9492c57e876e62fd3a2f2d0718a5894e43d3 [diff] |
Update with.md (#140)
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.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).