ChaseGilliam

ChaseGilliam

I’m generating docs as a deliverable for a client, and I want them to be hosted somewhere so that I can automate the process. I just need them to be behind a password/login. Has anyone here ever done that with Elixir docs?

Showing Posts 1 to 10

Ankhers

Ankhers

ex_doc generates html pages for you. It should be easy enough to set them up behind some kind of login. If you are using some sort of CI/CD, you should be able to automatically build the documentation and upload it to wherever you need to on a successful build release.

ChaseGilliam

ChaseGilliam OP

I guess I could s3 or something.

OvermindDL1

OvermindDL1

I can always host you some space if you want as well.

ChaseGilliam

ChaseGilliam OP

Appreciated, but I’ll just bill the client for S3 or whatever. I feel like there’s an interesting opportunity to build a simple service that’s like hex docs for private repos.

OvermindDL1

OvermindDL1

Offers open for about anyone, I have a lot of unused server right now. ^.^;

I’m not sure it is really hard though, plenty of free services for file doc hosting, hex/ex_docs builds static HTML so it is pretty dead-simple. :slight_smile:

ChaseGilliam

ChaseGilliam OP

On a slight tangent, do you know if it’s possible to capture the tests in ex_doc’s output?

OvermindDL1

OvermindDL1

You mean the DocTests? And capture in what way? The code itself, the output of the test, etc…?

ChaseGilliam

ChaseGilliam OP

No, I mean like generating a doc entry for specific test files. It seems silly, but I have to document test cases for a project, and I don’t want to have to use another tool or maintain a list of tests somewhere by hand.

Azolo

Azolo

So, I’m pretty sure that ExDoc is based off of compiled beam files. So…

You will probably want a different environment for just compiling docs.
You will need to add paths to be compile to your mix.exs via the :elixirc_paths option or figure out how to get whatever you want into the parsed beam.

There may be another way, but that’s how I would approach it with my current understanding.

ChaseGilliam

ChaseGilliam OP

Can you compile .exs files to beam? The test files won’t compile as .ex files if you’re using things like Phoenix’s ConnCase.

Where Next? Top

Trending in Questions Top

Hellowman
Hello everyone! I am new to coding with Elixir/Erlang. And i am looking for some utilities for fuzzing testing like AFL++. Does anyone ...
New
yarrichar
I’m very new to Elixir, so sorry if this is a silly question: I am wondering what happens to the mailbox of a process when the machine i...
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
Fl4m3Ph03n1x
Background When trying to execute mix release on a Windows 11 machine for a Phoenix project I get the following error: * assembling mark...
New
mandar1045
I load tested a plain Phoenix chat app backed by Postgres with 100 million messages in it, everything on default settings, to see what br...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New
saleyn
Is there a way to import record definitions in the iex shell for pretty printing (similar to the rr command in the erl shell)? This woul...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
261 13183 112
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
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
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
charlenopires
Hi everyone :waving_hand: I’ve been working on PhiaUI, an open-source UI component library for Phoenix LiveView, and I wanted to share i...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews