Move docs to mkdocs and improve them

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel
2019-11-17 18:11:33 +01:00
parent 60f1a84937
commit 4fab4e1d25
22 changed files with 534 additions and 160 deletions

39
mix.exs
View File

@@ -156,12 +156,7 @@ defmodule Mobilizon.Mixfile do
defp docs() do
[
source_ref: "v#{@version}",
extra_section: "GUIDES",
main: "introduction",
api_reference: false,
groups_for_modules: groups_for_modules(),
extras: extras(),
groups_for_extras: groups_for_extras(),
nest_modules_by_prefix: [
Mobilizon,
MobilizonWeb,
@@ -173,20 +168,6 @@ defmodule Mobilizon.Mixfile do
]
end
defp extras() do
[
"support/guides/development/development.md",
"support/guides/development/tests.md",
"support/guides/development/styleguide.md",
"support/guides/install/install.md",
"support/guides/install/dependencies.md",
"support/guides/install/docker.md",
"support/guides/introduction.md",
"support/guides/contributing.md",
"support/guides/code_of_conduct.md"
]
end
defp groups_for_modules() do
[
Models: [
@@ -326,24 +307,4 @@ defmodule Mobilizon.Mixfile do
]
]
end
defp groups_for_extras() do
[
Introduction: [
"support/guides/introduction.md",
"support/guides/contributing.md",
"support/guides/code_of_conduct.md"
],
Development: [
"support/guides/development/development.md",
"support/guides/development/tests.md",
"support/guides/development/styleguide.md"
],
Production: [
"support/guides/install/install.md",
"support/guides/install/docker.md",
"support/guides/install/dependencies.md"
]
]
end
end