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?
Where Next?
Trending in Questions
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Supporting innovation across the BEAM ecosystem.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #library
- #deployment
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #podcasts
- #javascript
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #ai
- #elixirconf-us
- #blog-post
- #elixir-ls
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #elixirconf-eu
- #metaprogramming
- #hex
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Master modern tools, write cleaner code, and tackle real-world challenges.
Bringing learning, work and compliance together since 1987.
Producing high quality Elixir screencasts since 2017.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
First Post!- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
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.
Most Liked
ChaseGilliam
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.
ChaseGilliam
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.
ChaseGilliam
It turns out that using
File.read!("test path goes here") Code.string_to_quoted!produces the AST and is perfectly usable for getting the moduledoc and test names. I’m putting together a package, and will share ti once I have it working.