CharlesIrvine

How do I get guides processed by ExDoc?

How do I get ExDoc to process and publish project guides?

For example, there is a guides directory in the Phoenix GitHub project. If go to the Phoenix hexdocs site, those docs are present.

How can I make this happen for my project?

Thanks

4 comments

#ex_doc

1 175 4

2024-05-27 21:02:28 UTC

Marked As Solved

LostKobrakai

github.com

phoenixframework/phoenix/blob/main/mix.exs#L121-L137


      
          defp docs do
            [
              source_ref: "v#{@version}",
              main: "overview",
              logo: "logo.png",
              extra_section: "GUIDES",
              assets: "guides/assets",
              formatters: ["html", "epub"],
              groups_for_modules: groups_for_modules(),
              extras: extras(),
              groups_for_extras: groups_for_extras(),
              groups_for_functions: [
                Reflection: &(&1[:type] == :reflection)
              ],
              skip_undefined_reference_warnings_on: ["CHANGELOG.md"]
            ]
          end

Post #2

Where Next?

View thread on forum (has 4 responses!)

ex_doc

Home Questions & Help>Questions

#ex_doc

1 176 4

Last post

Popular in Questions

Questions & Help>Questions

Import a module from a file into IEX

What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....

#iex

35 32139 16

2024-11-20 04:12:47 UTC

New

Questions & Help>Questions

BEAM file compliation error after degrading Erlang version from 22 to 21

I have followed this StackOverflow post to install the specific version of Erlang. And When I am running mix ecto.setup then getting fol...

/phoenix #erlang

33 15699 4

2019-06-10 13:33:06 UTC

New

Questions & Help>Questions

Defining Ecto Schemas (PostGres) to use NOT NULL in column definitions

I’m working on defining a simple Ecto schema for a table (in PostGres), but I don’t see where I can define a column as NOT NULL. Conside...

#ecto

29 14078 4

2018-06-15 19:49:48 UTC

New

Questions & Help>Questions

Convert a string to an integer?

Could someone help me? I'm making my first elixir program, number guessing game. I can't figure out how to convert the user's guess from ...

#how-to-question

3 14200 6

2017-04-25 23:42:13 UTC

New

Questions & Help>Questions

Websocket server in Elixir or phoenix

I’m trying to make a websocket server in Phoenix or raw Elixir. I heard about gun, I think I could use cowboy, but since I’m not that sma...

/phoenix #websockets

20 11315 8

2023-02-23 18:31:20 UTC

New

Questions & Help>Questions

DateTime Format to string?

Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...

#datetime

19 24687 16

2025-05-01 18:58:58 UTC

New

Questions & Help>Questions

Mint vs Finch vs Gun vs Tesla vs HTTPoison etc

Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...

#http_client

252 21859 30

2024-02-11 02:32:24 UTC

New

Questions & Help>Questions

Pattern match with multiple match options

I will often find my self writing things similar to: case some_value do nil -> something() "" -> something() _ -> someth...

#pattern-matching #how-to-question

29 15490 6

2017-11-07 18:34:26 UTC

New

Questions & Help>Questions

Ecto pool_size?

Can someone explain the settings of pool_size of Ecto in config file? and what is the recommend size? Thanks

#ecto

30 14050 5

2017-03-13 13:43:45 UTC

New

Questions & Help>Questions

Typespec for map w/both required and optional keys

Expanding on this topic: https://forum.elixirforum.net/t/map-typespec-question/19217 Let’s say I have a map with required and optional k...

#typespecs

27 13396 13

2021-05-11 14:59:42 UTC

New

Other popular topics

Questions & Help>Questions

Import a module from a file into IEX

What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....

#iex

35 32139 16

2024-11-20 04:12:47 UTC

New

Questions & Help>Questions

How to convert Date to DateTime which Ecto needs

Hello, I get Persian date from my client and convert it to normal calendar like this: def jalali_string_to_miladi_english_number(persi...

#ecto #datetime

15 14989 5

2023-02-25 00:11:31 UTC

New

News>Announcing

Oban - Reliable and Observable Job Processing

Hello! tl;dr Announcing Oban, an Ecto based job processing library with a focus on reliability and historical observability. After spen...

/oban #ecto #postgres #job-processing

977 41022 311

2025-10-22 10:32:47 UTC

New

Questions & Help>Questions

How to fix Bad argument in call to erlang:'++'(<<"xxx/crash.log">>, ".3") in lager_rotator_default:rotate_logfile/2 line 84

Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...

#production #error #log

2 46314 2

2024-02-18 13:22:44 UTC

New

Learning Resources>Chat/questions

Resources for building an e-commerce store in Phoenix?

I would like to know that is there any online source for learning Phoenix Framework for building E-Commerce Store? Any advantage on build...

/phoenix #ecommerce

137 23142 64

2024-05-27 15:57:16 UTC

New

Questions & Help>Questions

Difference in between :utc_datetime and :naive_datetime in Ecto

I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...

#ecto #timestamps

79 27907 15

2019-12-27 00:02:47 UTC

New

Questions & Help>Questions

Regex question for hyphen match

I’m not a pro in using Regex and can’t figure out why the following behaviour happens, especially if we take into account the difference ...

#learning-elixir

9 12939 10

2019-03-19 14:06:17 UTC

New

Chat & Discussions>Wikis

Phoenix LiveView Info

We’ve put together this wiki for Phoenix LiveView - please feel free to add any info you feel is worth including. What is Phoenix LiveV...

/phoenix #wiki #stickies #liveview

220 25307 74

2019-08-06 22:22:55 UTC

New

Questions & Help>Questions

Starship (cross-shell prompt) error - (starship::utils): Executing command "elixir" timed out

I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...

#starship

8 17167 3

2021-04-26 16:14:19 UTC

New

Learning Resources>Guides/Tuts/Tips/Info

Configuring VSCode to use with Elixir and Phoenix Templates

Hey :wave:t3: Elixir community, I’ve been learning Elixir, and working on some side projects. My editor of choice is VSCode, and althoug...

#phoenix_html #vs-code #vscode-elixir #elixir-ls

43 16832 15

2022-03-09 06:54:07 UTC

New

Questions & Help>Questions

Phoenix phx.gen.auth for umbrella app, how to: mix phx.gen.auth Accounts User users

Questions & Help>Questions

Nerves Buildroot for Arduino UNO Q

Questions & Help>Questions

CLI tool to get function name from line of source code

Questions & Help>Questions

Error: corrupt atom table using 1.19.3/OTP28 vs 27

Questions & Help>Questions

Reverse_proxy_plug appears to not use :verify and :cacerts arguments

Questions & Help>Questions

Why does _build/dev/consolidated get wiped out after mix format?

Questions & Help>Questions

Oban Pro website down

Questions & Help>Questions

Is this usage of Repo.transact an anti-pattern?

Questions & Help>Questions

Skipping validations when calling `Ash.can?`

Questions & Help>Questions

How to model this kind of project in Ash?

Questions & Help>Questions

Questions Questions ❯

Latest on Elixir Forum

Nerves v1.14.3 released!

News>News & Updates

Oban v2.23.0 released!

News>News & Updates

Membrane v1.2.6 released!

News>News & Updates

Changes to the struct update syntax

Official Elixir>Notices

2026/12/08- Advent of Code - Fukuoka, Japan

Events/Confs/Meet Ups>List

Senior Elixir Engineer - Elixir/Phoenix/Ash, Fresh Clinics, Remote (AUS / Sydney HQ)

Jobs & Member Profiles>Jobs

Setting up for Advent of Code 2025

Learning Resources>Coding Challenges

Patch Package OTP 28.2 Released

News>Erlang News

`maint` and `master` have been force-pushed to correct a mistake, again

News>Erlang News

Elixir and Phoenix developer - visuellverstehen, Flensburg / Dortmund, Remote Germany - German required

Jobs & Member Profiles>Jobs

Phoenix phx.gen.auth for umbrella app, how to: mix phx.gen.auth Accounts User users

Questions & Help>Questions

Distributed Elixir Made Simple - Johanna Larsson | ElixirConf EU 2025

Learning Resources>Talks

ExSift - High-performance MongoDB-style query filtering for Elixir

News>Announcing

Nerves Buildroot for Arduino UNO Q

Questions & Help>Questions

Keynote: CyanView & Elixir in Broadcasts – Daniil Popov, David Bourgeois | Code BEAM Europe 2025

Learning Resources>Talks

Elixir Forum ❯

Sub Categories:

Forums

We're in Beta

About us Mission Statement

How do I get guides processed by ExDoc?

CharlesIrvine

How do I get guides processed by ExDoc?

Marked As Solved

LostKobrakai

Where Next?

Popular in Questions

Import a module from a file into IEX

BEAM file compliation error after degrading Erlang version from 22 to 21

Defining Ecto Schemas (PostGres) to use NOT NULL in column definitions

Convert a string to an integer?

Websocket server in Elixir or phoenix

DateTime Format to string?

Mint vs Finch vs Gun vs Tesla vs HTTPoison etc

Pattern match with multiple match options

Ecto pool_size?

Typespec for map w/both required and optional keys

Other popular topics

Import a module from a file into IEX

How to convert Date to DateTime which Ecto needs

Oban - Reliable and Observable Job Processing

How to fix *Bad argument in call to erlang:'++'(<<"xxx/crash.log">>, ".3") in lager_rotator_default:rotate_logfile/2 line 84*

Resources for building an e-commerce store in Phoenix?

Difference in between :utc_datetime and :naive_datetime in Ecto

Regex question for hyphen match

Phoenix LiveView Info

Starship (cross-shell prompt) error - (starship::utils): Executing command "elixir" timed out

Configuring VSCode to use with Elixir and Phoenix Templates

Questions & Help>Questions

Latest on Elixir Forum

Sponsor Spotlight

Our Sponsors

Categories:

Sub Categories:

Forums

Our Sponsors

We're in Beta

How to fix Bad argument in call to erlang:'++'(<<"xxx/crash.log">>, ".3") in lager_rotator_default:rotate_logfile/2 line 84