Closed pnezis closed 2 months ago
Good catch. --docs-path
would be the most extensible way to go about it. Before doing that though I'm curious if we should go with something easier, i.e. mix hex.publish
when publishing docs would look at Mix.Project.config()[:docs][:output]
first. WDYT?
Mix.Project.config()[:docs][:output]
was also my first approach and I am fine going with this but:
ex_doc
:docs
is a function instead of keyword listGood call, imho let's go with --docs-dir
then. wdyt @ericmj @supersimple?
I don't mind having defaults that match ex_doc since that's probably what 99%+ of mix+hex users are using. I think we should start by reading Mix.Project.config()[:docs]
and if there is a need for --docs-dir
we can add it later.
If you have set a different output folder for the docs in your project config then
hex.publish
will raise because it expects the docs to be under adoc
ordocs
folderI can see two ways to address this:
mix hex.publish --docs-path ....
WDYT? Glad to send a PR.