Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify code block syntax #24693

Merged
merged 1 commit into from
Mar 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions presto-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,42 +5,42 @@ 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
```


## 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
```
Expand All @@ -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
```
Expand Down
Loading