Update docstrings and add docs pages

docs/make.jl

@@ -5,6 +5,9 @@ makedocs(
     format=:html,
     pages=[
         "Home" => "index.md",
+        "Package Generation" => "pages/package_generation.md",
+        "Plugins" => "pages/plugins.md",
+        "Licenses" => "pages/licenses.md",
     ],
     repo="https://github.com/christopher-dG/PkgTemplates.jl/blob/{commit}{path}#L{line}",
     sitename="PkgTemplates.jl",

docs/src/pages/index.md

@@ -0,0 +1,4 @@
+# Index
+
+```@index
+```

docs/src/pages/licenses.md

@@ -0,0 +1,15 @@
+```@meta
+CurrentModule = PkgTemplates
+```
+
+# Licenses
+
+[Many open-source licenses](https://github.com/invenia/PkgTemplates.jl/tree/master/licenses)
+are available for use with `PkgTemplates`, but if you see that one is missing,
+don't hesitate to open an issue or PR.
+
+## show_license
+
+```@docs
+show_license
+```

docs/src/pages/package_generation.md

@@ -0,0 +1,20 @@
+```@meta
+CurrentModule = PkgTemplates
+```
+
+# Package Generation
+
+Creating new packages with `PkgTemplates` revolves around creating a new
+[`Template`](@ref), then calling [`generate`](@ref) on it.
+
+## Template
+
+```@docs
+Template
+```
+
+## generate
+
+```@docs
+generate
+```

docs/src/pages/plugins.md

@@ -0,0 +1,35 @@
+```@meta
+CurrentModule = PkgTemplates
+```
+
+# Plugins
+
+## TravisCI
+
+```@docs
+TravisCI
+```
+
+## AppVeyor
+
+```@docs
+AppVeyor
+```
+
+## CodeCov
+
+```@docs
+CodeCov
+```
+
+## Documenter
+
+```@docs
+Documenter
+```
+
+## GitHubPages
+
+```@docs
+GitHubPages
+```

src/plugins/appveyor.jl

@@ -1,10 +1,10 @@
 """
-    AppVeyor(; config_file::AbstractString="") -> AppVeyor
+    AppVeyor(; config_file::Union{AbstractString, Void}="") -> AppVeyor
 
 Add AppVeyor to a template's plugins to add AppVeyor CI support.
 
 # Keyword Arguments
-* `config_file::Union{AbstractString, Void}`: Path to a custom `.appveyor.yml`.
+* `config_file::Union{AbstractString, Void}=""`: Path to a custom `.appveyor.yml`.
   If `nothing` is supplied, then no file will be generated.
 """
 @auto_hash_equals struct AppVeyor <: Plugin

src/plugins/codecov.jl

@@ -1,10 +1,10 @@
 """
-    CodeCov(; config_file::AbstractString="") -> CodeCov
+    CodeCov(; config_file::Union{AbstractString, Void}="") -> CodeCov
 
 Add CodeCov to a template's plugins to enable CodeCov coverage reports.
 
 # Keyword Arguments:
-* `config_file::AbstractString`: Path to a custom `.codecov.yml`.
+* `config_file::Union{AbstractString, Void}=""`: Path to a custom `.codecov.yml`.
   If `nothing` is supplied, then no file will be generated.
 """
 @auto_hash_equals struct CodeCov <: Plugin

src/plugins/travis.jl

@@ -1,10 +1,10 @@
 """
-    TravisCI(; config_file::AbstractString="") -> TravisCI
+    TravisCI(; config_file::Union{AbstractString, Void}="") -> TravisCI
 
 Add TravisCI to a template's plugins to add Travis CI support.
 
 # Keyword Arguments:
-* `config_file::AbstractString`: Path to a custom `.travis.yml`.
+* `config_file::Union{AbstractString, Void}=""`: Path to a custom `.travis.yml`.
   If `nothing` is supplied, then no file will be generated.
 """
 @auto_hash_equals struct TravisCI <: Plugin

src/template.jl

@@ -10,8 +10,8 @@ Records common information used to generate a package.
   username. This is case-sensitive for some plugins, so take care to enter it correctly.
 * `host::AbstractString="github.com"`: Code hosting service where your package will reside.
 * `license::Union{AbstractString, Void}=nothing`: Name of the package licsense. If
-  no license is specified, no license is created. `show_license` can be used to list all
+  no license is specified, no license is created. [`show_license`](@ref) can be used to
-  available licenses, or to print out a particular license's text.
+  list all available licenses, or to print out a particular license's text.
 * `authors::Union{AbstractString, Array}=LibGit2.getconfig("user.name", "")`: Names that
   appear on the license. Supply a string for one author, and an array for multiple.
 * `years::Union{Int, AbstractString}=string(Dates.year(Dates.today()))`: Copyright years