Skip to content

Update commands for building docs in CONTRIBUTING.md #14945

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.

Sign up for GitHub

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

Merged
josevalim merged 2 commits into from
Nov 22, 2025
Merged

Update commands for building docs in CONTRIBUTING.md #14945

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbf7ad6
Update commands in CONTRIBUTING.md
eksperimental Nov 21, 2025
66792c6
Fix instructions for building docs from release sources
eksperimental Nov 21, 2025
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
19 changes: 10 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,19 +177,20 @@ 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.
Comment thread
josevalim marked this conversation as resolved.

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 run:
# Now we will go back to Elixir's root directory,
cd "${elixir_dir}"

```sh
make docs # to generate HTML pages
make docs DOCS_FORMAT=epub # to generate EPUB documents
# and generate HTML and EPUB documents:
make docs
```

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