Improving documents

This commit is contained in:
Eishun Kondoh 2019-03-18 22:35:06 +09:00
parent 44670cfbce
commit 15d8fd57f3
2 changed files with 79 additions and 3 deletions

77
mix.exs
View file

@ -5,12 +5,13 @@ defmodule Tres.Mixfile do
[
app: :tres,
version: "0.1.0",
elixir: "~> 1.5",
elixir: "~> 1.8",
start_permanent: Mix.env() == :prod,
escript: [main_module: Openflow.EnumGen, name: :enum_gen, path: "bin/enum_gen"],
compilers: [:erlang] ++ Mix.compilers(),
deps: deps(),
aliases: [test: "test --no-start", compile: ["escript.build"]]
aliases: [test: "test --no-start", compile: ["escript.build"]],
docs: docs()
]
end
@ -25,7 +26,77 @@ defmodule Tres.Mixfile do
{:ranch, "~> 1.7.1"},
{:eovsdb, github: "shun159/eovsdb", branch: "master"},
{:jsone, github: "sile/jsone", tag: "1.4.6", override: true},
{:epcap, github: "msantos/epcap", branch: "master", only: :test}
{:epcap, github: "msantos/epcap", branch: "master", only: :test},
# Document
{:earmark, "~> 1.2.6", only: :dev, runtime: false},
{:ex_doc, "~> 0.19", only: :dev, runtime: false}
]
end
defp docs do
[
groups_for_modules: groups_for_modules(),
formatters: ["html"],
]
end
defp groups_for_modules do
[
"Actions": [
Openflow.Action.Output,
Openflow.Action.CopyTtlOut,
Openflow.Action.CopyTtlIn,
Openflow.Action.SetMplsTtl,
Openflow.Action.DecMplsTtl,
Openflow.Action.PushVlan,
Openflow.Action.PopVlan,
Openflow.Action.PushMpls,
Openflow.Action.PopMpls,
Openflow.Action.SetQueue,
Openflow.Action.Group,
Openflow.Action.SetNwTtl,
Openflow.Action.DecNwTtl,
Openflow.Action.SetField,
Openflow.Action.PushPbb,
Openflow.Action.PopPbb,
Openflow.Action.NxResubmit,
Openflow.Action.NxSetTunnel,
Openflow.Action.NxRegMove,
Openflow.Action.NxRegLoad,
Openflow.Action.NxNote,
Openflow.Action.NxSetTunnel64,
Openflow.Action.NxMultipath,
Openflow.Action.NxBundle,
Openflow.Action.NxBundleLoad,
Openflow.Action.NxResubmitTable,
Openflow.Action.NxOutputReg,
Openflow.Action.NxLearn,
Openflow.Action.NxExit,
Openflow.Action.NxDecTtl,
Openflow.Action.NxFinTimeout,
Openflow.Action.NxController,
Openflow.Action.NxDecTtlCntIds,
Openflow.Action.NxWriteMetadata,
Openflow.Action.NxPushMpls,
Openflow.Action.NxPopMpls,
Openflow.Action.NxStackPush,
Openflow.Action.NxStackPop,
Openflow.Action.NxSample,
Openflow.Action.NxOutputReg2,
Openflow.Action.NxRegLoad2,
Openflow.Action.NxConjunction,
Openflow.Action.NxConntrack,
Openflow.Action.NxNat,
Openflow.Action.NxController2,
Openflow.Action.NxSample2,
Openflow.Action.NxOutputTrunc,
Openflow.Action.NxGroup,
Openflow.Action.NxSample3,
Openflow.Action.NxClone,
Openflow.Action.NxCtClear,
Openflow.Action.NxResubmitTableCt,
Openflow.Action.NxLearn2
]
]
end
end