jononomo

jononomo

So I have a Phoenix web application in progress. I am able to generate documentation for my codebase using the ex_doc tool – when I run mix docs I get the documentation output into the doc/ folder.

I can then open this doc/ folder, double click on index.html, and view these docs in my browser at file:///Users/jon/myapp/doc/api-reference.html (because index.html just redirects to api_reference.html).

However, I would like these docs to be part of my Phoenix web application – in other words, I would like them available in production at the domain where my app is running. So if my app is running at myapp.com, then I would like to be able to see the docs at a URL like 应用宝官网-全网最新最热手机应用游戏下载

Also, the documentation for ex_doc (ExDoc — ExDoc v0.40.3) instructs me to include the following in my mix.exs file:

def deps do
[
{:ex_doc, “~> 0.24”, only: :dev, runtime: false},
]
end

I’m curious what the runtime: false option does.

Thanks.

First 2 of 2 Posts Switch mode

aswinmohanme

aswinmohanme

runtime: false means the package will not be available in production. Combined with only: :dev means the package is available in development mode. This means you can generate the documentation only in the development and the build phase and the package won’t be available when the app is running in production mode.

LostKobrakai

LostKobrakai

You shouldn’t need ex_doc in production. There are few ways to generate documentation e.g. when building a release. Make sure the doc/ folder is retained with the release (overlay or copy into priv/) and then you can serve the docs using Plug.Static within phoenix.

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
roeland
Kia ora, We have been using elixir-google-api to connect to Google Drive. However, with the updates to Tesla due to CVEs this is now bro...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
rahultumpala
Hello, I have an Elixir backend that implements a custom protocol over TCP. I want to load test the backend and assess the performance o...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New

We're in Beta

About us Mission Statement