From 5ab2619fa9bd3d9249d2bf4a36e41e677a18f804 Mon Sep 17 00:00:00 2001 From: dnskr Date: Sun, 9 Mar 2025 15:51:23 +0100 Subject: [PATCH] Specify code block syntax --- presto-docs/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/presto-docs/README.md b/presto-docs/README.md index 4fcff1f6c7e66..247103758f7c2 100644 --- a/presto-docs/README.md +++ b/presto-docs/README.md @@ -5,24 +5,24 @@ Presto documentation is authored in `rst` format and published using [Sphinx](ht ## Prerequisites Building the presto-docs module requires Python3 with virtual environment. You can check if you have it installed by running: -``` +```shell python3 -m venv --help ``` To install venv: -``` +```shell python3 -m pip install --user virtualenv ``` Optionally, the PDF version of `presto-docs` requires LaTeX tooling. For MacOS, -``` +```shell brew install --cask mactex ``` For Ubuntu, -``` +```shell sudo apt-get update sudo apt-get install -y texlive-fonts-recommended texlive-latex-recommended texlive-latex-extra latexmk tex-gyre texlive-xetex fonts-freefont-otf xindy ``` @@ -30,17 +30,17 @@ sudo apt-get install -y texlive-fonts-recommended texlive-latex-recommended texl ## Building manually The default build uses Apache Maven to download dependencies and generate the HTML. You can run it as follows: -``` +```shell cd presto-docs mvn install ``` Or, to build the documentation more quickly: -``` +```shell cd presto-docs ./build ``` To build PDF version of the documentation -``` +```shell cd presto-docs ./build --with-pdf ``` @@ -49,11 +49,11 @@ cd presto-docs When the build is complete, you'll find the output HTML files in the `target/html/` folder. To view the docs, you can open the file `target/html/index.html` in a web browser on macOS with -``` +```shell open target/html/index.html ``` Or, you can start a web server e.g., using Python: -``` +```shell cd target/html/ python3 -m http.server ```