Skip to content

Commit dc39868

Browse files
Update commands for building docs in CONTRIBUTING.md (#14945)
- `$DOCS_FORMAT` is no longer supported in Makefile - By default HTML and EPUB doc formats are created
1 parent a2f21c9 commit dc39868

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -184,19 +184,20 @@ affecting **all external contributors**:
184184
## Building documentation
185185

186186
Building the documentation requires that [ExDoc](https://github.com/elixir-lang/ex_doc)
187-
is installed and built alongside Elixir:
187+
is installed and built alongside Elixir.
188+
189+
After cloning and compiling Elixir, run:
188190

189191
```sh
190-
# After cloning and compiling Elixir, in its parent directory:
191-
git clone https://github.com/elixir-lang/ex_doc.git
192-
cd ex_doc && ../elixir/bin/elixir ../elixir/bin/mix do deps.get + compile
193-
```
192+
elixir_dir=$(pwd)
193+
cd .. && git clone https://github.com/elixir-lang/ex_doc.git
194+
cd ex_doc && "${elixir_dir}/bin/elixir" "${elixir_dir}/bin/mix" do deps.get + compile
194195
195-
Now go back to Elixir's root directory and run:
196+
# Now we will go back to Elixir's root directory,
197+
cd "${elixir_dir}"
196198
197-
```sh
198-
make docs # to generate HTML pages
199-
make docs DOCS_FORMAT=epub # to generate EPUB documents
199+
# and generate HTML and EPUB documents:
200+
make docs
200201
```
201202

202203
This will produce documentation sets for `elixir`, `eex`, `ex_unit`, `iex`, `logger`,

0 commit comments

Comments
 (0)