How do I get guides processed by ExDoc?

CharlesIrvine · May 27, 2024, 6:22pm

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

LostKobrakai · May 27, 2024, 6:28pm

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

CharlesIrvine · May 27, 2024, 6:56pm

Looks good. Thanks

CharlesIrvine · May 27, 2024, 8:58pm

@LostKobrakai Well, it looked like you gave me enough to figure it out, but I’m not there yet. The only thing in your snippet that looks relevant is **extra_section: “GUIDES”. I tried creating a top level dir with that name and added a markdown files to it. When I generate docs I get that section, but the content is unchanged.

Is there some additional documentation somewhere?

Thanks

CharlesIrvine · May 27, 2024, 9:02pm

Never mind. I just needed to read down a bit. Sorry.