Skip to content

Update commands for building docs in CONTRIBUTING.md#14945

Merged
josevalim merged 2 commits intoelixir-lang:mainfrom
eksperimental-forks:chore/update-commands-in-contributing
Nov 22, 2025
Merged

Update commands for building docs in CONTRIBUTING.md#14945
josevalim merged 2 commits intoelixir-lang:mainfrom
eksperimental-forks:chore/update-commands-in-contributing

Conversation

@eksperimental
Copy link
Contributor

  • $DOCS_FORMAT is no longer supported in Makefile
  • By default HTML and EPUB doc formats are created

Also 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.

unzip -l v1.19.3.zip
Archive:  v1.19.3.zip
https://github.com/elixir-lang/elixir/commit/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.

- `$DOCS_FORMAT` is no longer supported in Makefile
- By default HTML and EPUB doc formats are created
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.
@josevalim josevalim merged commit dc39868 into elixir-lang:main Nov 22, 2025
14 checks passed
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

@eksperimental eksperimental deleted the chore/update-commands-in-contributing branch November 22, 2025 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants