Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make ex_doc and inch_ex dev only #9

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tsloughter
Copy link
Member

Needed to do this so doc generation worked, I guess because docs env doesn't exist.

@tsloughter
Copy link
Member Author

I don't know what inch_report is..

@hauleth
Copy link
Member

hauleth commented Feb 11, 2019

@tsloughter you can do env MIX_ENV=docs mix docs. In Mix you do not need to define environments, all are already there.

@hauleth hauleth self-requested a review February 11, 2019 20:00
@tsloughter
Copy link
Member Author

And I have to publish the package with MIX_ENV=docs?

@hauleth
Copy link
Member

hauleth commented Feb 11, 2019

This is how I have been doing that, alternatively you can add :dev as well to the :only list.

About Inch, this is CI for the documentation: https://inch-ci.org/github/opencensus-beam/opencensus_elixir

@garthk
Copy link

garthk commented May 6, 2019

So glad I read this; turned out I'd broken mix docs also by copying the pattern. Ended up with:

  def project do
    [
      preferred_cli_env: [
        # ...
        docs: :docs,
        inch: :docs,
        "inch.report": :docs,
        "inchci.add": :docs
      ],
     # ...
    ]
  end

… and

  defp deps() do
    [
      # ...
      {:ex_doc, ">= 0.0.0", only: [:dev, :docs], runtime: false},
      # ...
      {:inch_ex, "~> 2.0.0", only: :docs, runtime: false},
      # ...
    ]
  end

… so mix publish in particular can also generate docs.

@garthk
Copy link

garthk commented Jun 23, 2019

@tsloughter want me to pick this work up if you're concentrating more on the Erlang side of things?

@tsloughter
Copy link
Member Author

@garthk that'd be great, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants