Skip to content

Commit 66792c6

Browse files
committed
Fix instructions for building docs from release sources
The following instructions do not work because the source code version of the release create a folder with the version in it. ```console ❯ unzip -l v1.19.3.zip Archive: v1.19.3.zip 427d21e Length Date Time Name --------- ---------- ----- ---- 0 11-13-2025 11:33 elixir-1.19.3/ 502 11-13-2025 11:33 elixir-1.19.3/.formatter.exs ... ``` So the instructions do not work because it expects a folder named `elixir/`. Instructions have been updated to work from the Git repo as well as from the downloaded release source files.
1 parent bbf7ad6 commit 66792c6

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -177,17 +177,19 @@ affecting **all external contributors**:
177177
## Building documentation
178178

179179
Building the documentation requires that [ExDoc](https://github.com/elixir-lang/ex_doc)
180-
is installed and built alongside Elixir:
180+
is installed and built alongside Elixir.
181+
182+
After cloning and compiling Elixir, run:
181183

182184
```sh
183-
# After cloning and compiling Elixir, in its parent directory:
184-
git clone https://github.com/elixir-lang/ex_doc.git
185-
cd ex_doc && ../elixir/bin/elixir ../elixir/bin/mix do deps.get + compile
186-
```
185+
elixir_dir=$(pwd)
186+
cd .. && git clone https://github.com/elixir-lang/ex_doc.git
187+
cd ex_doc && "${elixir_dir}/bin/elixir" "${elixir_dir}/bin/mix" do deps.get + compile
187188
188-
Now go back to Elixir's root directory and generate HTML and EPUB documents:
189+
# Now we will go back to Elixir's root directory,
190+
cd "${elixir_dir}"
189191
190-
```sh
192+
# and generate HTML and EPUB documents:
191193
make docs
192194
```
193195

0 commit comments

Comments
 (0)