From bbf7ad676994f62d5bf145c3c5d12979059c38f0 Mon Sep 17 00:00:00 2001 From: Eksperimental Date: Fri, 21 Nov 2025 17:55:35 -0500 Subject: [PATCH 1/2] Update commands in CONTRIBUTING.md - `$DOCS_FORMAT` is no longer supported in Makefile - By default HTML and EPUB doc formats are created --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6c22a9cf3f..a25fe78e581 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -185,11 +185,10 @@ git clone https://github.com/elixir-lang/ex_doc.git cd ex_doc && ../elixir/bin/elixir ../elixir/bin/mix do deps.get + compile ``` -Now go back to Elixir's root directory and run: +Now go back to Elixir's root directory and generate HTML and EPUB documents: ```sh -make docs # to generate HTML pages -make docs DOCS_FORMAT=epub # to generate EPUB documents +make docs ``` This will produce documentation sets for `elixir`, `eex`, `ex_unit`, `iex`, `logger`, From 66792c6f41d50b3f65fa24558e33da429ab2042b Mon Sep 17 00:00:00 2001 From: Eksperimental Date: Fri, 21 Nov 2025 18:38:13 -0500 Subject: [PATCH 2/2] Fix instructions for building docs from release sources MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 427d21e410d1846c232d0a0b0e87cce629884dfa 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. --- CONTRIBUTING.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a25fe78e581..1ee8b5fa1b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,17 +177,19 @@ affecting **all external contributors**: ## Building documentation Building the documentation requires that [ExDoc](https://github.com/elixir-lang/ex_doc) -is installed and built alongside Elixir: +is installed and built alongside Elixir. + +After cloning and compiling Elixir, run: ```sh -# After cloning and compiling Elixir, in its parent directory: -git clone https://github.com/elixir-lang/ex_doc.git -cd ex_doc && ../elixir/bin/elixir ../elixir/bin/mix do deps.get + compile -``` +elixir_dir=$(pwd) +cd .. && git clone https://github.com/elixir-lang/ex_doc.git +cd ex_doc && "${elixir_dir}/bin/elixir" "${elixir_dir}/bin/mix" do deps.get + compile -Now go back to Elixir's root directory and generate HTML and EPUB documents: +# Now we will go back to Elixir's root directory, +cd "${elixir_dir}" -```sh +# and generate HTML and EPUB documents: make docs ```