Merge pull request #59 from JuliaGeodynamics/pa-patch

fix `@ref`

.codecov.yaml

@@ -7,4 +7,4 @@ coverage:
       default:
         informational: true
     changes: false
-comment: false
+comment: true

AUTHORS.md

@@ -4,7 +4,7 @@ GeophysicalModelGenerator.jl's development is coordinated by a group of *princip
 who are also its main contributors and who can be contacted in case of
 questions about GeophysicalModelGenerator.jl. In addition, there are *contributors* who have
 provided substantial additions or modifications. Together, these two groups form
-"The GeophysicalModelGenerator.jl Authors" as mentioned in the [LICENSE.md](LICENSE.md) file.
+"The GeophysicalModelGenerator.jl Authors".
 
 ## Principal Developers
 * [Boris Kaus](https://www.geosciences.uni-mainz.de/geophysics-and-geodynamics/team/univ-prof-dr-boris-kaus/),
@@ -20,6 +20,7 @@ are listed in alphabetical order:
 * Pascal Aellig
 * Luca De Siena
 * Andrea Piccolo
+* Hendrik Rachona
 * Christian Schuler
 * Arne Spang
 * Tatjana Weiler

CONTRIBUTING.md

@@ -6,8 +6,7 @@ as pull requests) any time. For planned larger contributions, it is often
 beneficial to get in contact with one of the principal developers first (see
 [AUTHORS.md](AUTHORS.md)).
 
-GeophysicalModelGenerator.jl and its contributions are licensed under the MIT license (see
-[LICENSE.md](LICENSE.md)). As a contributor, you certify that all your
+GeophysicalModelGenerator.jl and its contributions are licensed under the MIT license. As a contributor, you certify that all your
 contributions are in conformance with the *Developer Certificate of Origin
 (Version 1.1)*, which is reproduced below.
 

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Boris Kaus, Marcel Thielmann and Authors (see AUTHORS.md)
+Copyright (c) 2021 Boris Kaus, Marcel Thielmann and Authors (see [AUTHORS.md](AUTHORS.md))
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/make.jl

@@ -7,17 +7,32 @@ using Documenter
 # Get GeophysicalModelGenerator.jl root directory
 GMG_root_dir = dirname(@__DIR__)
 
+license = read(joinpath(GMG_root_dir, "LICENSE.md"), String)
+write(joinpath(@__DIR__, "src", "man", "license.md"), license)
 # Copy list of authors to not need to synchronize it manually
 authors_text = read(joinpath(GMG_root_dir, "AUTHORS.md"), String)
-authors_text = replace(authors_text, "in the [LICENSE.md](LICENSE.md) file" => "under [License](@ref)")
+# authors_text = replace(authors_text, "in the [LICENSE.md](LICENSE.md) file" => "under [License](@ref)")
 write(joinpath(@__DIR__, "src", "man", "authors.md"), authors_text)
-#Contributing
-contributing = read(joinpath(GMG_root_dir, "CONTRIBUTING.md"), String)
-write(joinpath(@__DIR__, "src", "man", "contributing.md"), contributing)
 
 # Copy some files from the repository root directory to the docs and modify them
 # as necessary
 # Based on: https://github.com/ranocha/SummationByPartsOperators.jl/blob/0206a74140d5c6eb9921ca5021cb7bf2da1a306d/docs/make.jl#L27-L41
+open(joinpath(@__DIR__, "src", "man", "license.md"), "w") do io
+  # Point to source license file
+  println(io, """
+  ```@meta
+  EditURL = "https://github.com/JuliaGeodynamics/GeophysicalModelGenerator.jl/blob/main/LICENSE.md"
+  ```
+  """)
+  # Write the modified contents
+  println(io, "# [License](@id license)")
+  println(io, "")
+  for line in eachline(joinpath(dirname(@__DIR__), "LICENSE.md"))
+    line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)")
+    println(io, "> ", line)
+  end
+end
+
 open(joinpath(@__DIR__, "src", "man", "code_of_conduct.md"), "w") do io
   # Point to source license file
   println(io, """
@@ -46,7 +61,6 @@ open(joinpath(@__DIR__, "src", "man", "contributing.md"), "w") do io
     for line in eachline(joinpath(dirname(@__DIR__), "CONTRIBUTING.md"))
       line = replace(line, "[LICENSE.md](LICENSE.md)" => "[License](@ref)")
       line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)")
-    #   line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)")
       println(io, "> ", line)
     end
   end
@@ -93,7 +107,8 @@ makedocs(;
         "List of functions"  => "man/listfunctions.md",
         "Authors" => "man/authors.md",
         "Contributing" => "man/contributing.md",
-        "Code of Conduct" => "man/code_of_conduct.md"
+        "Code of Conduct" => "man/code_of_conduct.md",
+        "License" => "man/license.md"
     ],
 )