diff options
| author | Eksperimental <eksperimental@users.noreply.github.com> | 2019-12-14 02:08:40 +0700 |
|---|---|---|
| committer | José Valim <jose.valim@plataformatec.com.br> | 2019-12-13 20:08:39 +0100 |
| commit | 43155fbe1f0fdc96e606882f49ee6a1d4015dd84 (patch) | |
| tree | faa658708a69c3305506d86e9ccc1e717e591489 | |
| parent | 022cb660202e7168147ae2c96416f92625e1f043 (diff) | |
| download | elixir-43155fbe1f0fdc96e606882f49ee6a1d4015dd84.tar.gz | |
Use long attributes in make docs target + Use double-quotes around attribute values (#9650)
* Use long attributes in make docs target
Use Elixir as a learning tool. Use long attributes to lower the barrier so users can
see the meaning of ExDoc command line attributes
* Use double-quotes around attribute values in docs target in Makefile
| -rw-r--r-- | Makefile | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -175,16 +175,16 @@ clean_residual_files: #==> Documentation tasks LOGO_PATH = $(shell test -f ../docs/logo.png && echo "--logo ../docs/logo.png") -SOURCE_REF = $(shell tag="$(call GIT_TAG)" revision="$(call GIT_REVISION)"; echo "$${tag:-$$revision}\c") +SOURCE_REF = $(shell tag="$(call GIT_TAG)" revision="$(call GIT_REVISION)"; echo "$${tag:-$$revision}") DOCS_FORMAT = html -COMPILE_DOCS = bin/elixir ../ex_doc/bin/ex_doc "$(1)" "$(VERSION)" "lib/$(2)/ebin" -m "$(3)" -u "https://github.com/elixir-lang/elixir" --source-ref "$(call SOURCE_REF)" $(call LOGO_PATH) -o doc/$(2) -n https://hexdocs.pm/$(2)/$(CANONICAL) -p https://elixir-lang.org/docs.html -f "$(DOCS_FORMAT)" $(4) +COMPILE_DOCS = bin/elixir ../ex_doc/bin/ex_doc "$(1)" "$(VERSION)" "lib/$(2)/ebin" --main "$(3)" --source-url "https://github.com/elixir-lang/elixir" --source-ref "$(call SOURCE_REF)" $(call LOGO_PATH) --output doc/$(2) --canonical "https://hexdocs.pm/$(2)/$(CANONICAL)" --homepage-url "https://elixir-lang.org/docs.html" --formatter "$(DOCS_FORMAT)" $(4) docs: compile ../ex_doc/bin/ex_doc docs_elixir docs_eex docs_mix docs_iex docs_ex_unit docs_logger docs_elixir: compile ../ex_doc/bin/ex_doc @ echo "==> ex_doc (elixir)" $(Q) rm -rf doc/elixir - $(call COMPILE_DOCS,Elixir,elixir,Kernel,-c lib/elixir/docs.exs) + $(call COMPILE_DOCS,Elixir,elixir,Kernel,--config "lib/elixir/docs.exs") docs_eex: compile ../ex_doc/bin/ex_doc @ echo "==> ex_doc (eex)" |