Set up documentation + lint (#121)

- remove some automatically generated stuff not should even be in
repository
- set up lint + Documents.jl in same way it is defined in freshly started projects
- add lint + doctest to after_success so that build pass, these needs to be fixed later
- build is failing on nightly (0.7) but it's ok for release (0.5.2)
- Documenter.jl supports doctests, so this closes least #23
- build system is now on Travis-CI completely, so this closes also #68

.gitignore

@@ -1,7 +1,8 @@
 *~
 .DS_Store
 .ipynb_checkpoints
-docs/build/html
+docs/build/
+docs/site/
 *.swp
 *.lnk
 *.mess

.travis.yml

@@ -3,7 +3,7 @@ os:
   - linux
 julia:
   - release
-#  - nightly
+  - nightly
 notifications:
   email: false
   webhooks:
@@ -12,11 +12,17 @@ notifications:
     on_success: change  # options: [always|never|change] default: always
     on_failure: always  # options: [always|never|change] default: always
     on_start: false     # default: false
-#script:
-#  - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
-#  - julia -e 'Pkg.init(); Pkg.clone(pwd()); Pkg.build("JuliaFEM"); Pkg.test("JuliaFEM"; coverage=true)'
-#  - julia -e 'Pkg.init(); Pkg.clone(pwd()); Pkg.build("JuliaFEM")'
+before_script:
+    - julia --color=yes -e 'Pkg.clone(pwd())'
+    - julia --color=yes -e 'Pkg.add("Coverage")'
+    - julia --color=yes -e 'Pkg.add("Documenter")'
+    - julia --color=yes -e 'Pkg.add("Lint")'
+script:
+    - julia --color=yes -e 'Pkg.build("JuliaFEM")'
+    - julia --color=yes -e 'Pkg.test("JuliaFEM", coverage=true)'
 after_success:
-# - julia -e 'Pkg.test("JuliaFEM"; coverage=true)'
- - julia -e 'cd(Pkg.dir("JuliaFEM")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
+    - julia --color=yes -e 'cd(Pkg.dir("JuliaFEM", "test")); include("run_lint.jl")'
+    - julia --color=yes -e 'cd(Pkg.dir("JuliaFEM", "docs")); include("make.jl")'
+    - julia --color=yes -e 'cd(Pkg.dir("JuliaFEM")); using Coverage; Coveralls.submit(Coveralls.process_folder())'
+    - julia --color=yes -e 'cd(Pkg.dir("JuliaFEM", "docs")); include("deploy.jl")'
 

docs/deploy.jl

@@ -0,0 +1,9 @@
+# This file is a part of JuliaFEM.
+# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE
+
+using Documenter
+using JuliaFEM
+
+deploydocs(
+    deps = Deps.pip("mkdocs", "python-markdown-math"),
+    repo = "github.com/JuliaFEM/JuliaFEM.jl.git")

docs/make.jl

@@ -0,0 +1,10 @@
+# This file is a part of project JuliaFEM.
+# License is MIT: see https://github.com/JuliaFEM/NodeNumbering.jl/blob/master/LICENSE
+
+using Documenter
+using JuliaFEM
+
+makedocs(
+    modules = [JuliaFEM],
+    checkdocs = :all,
+    strict = false)

docs/mkdocs.yml

@@ -0,0 +1,26 @@
+site_name: JuliaFEM.jl
+repo_url: https://github.com/JuliaFEM/JuliaFEM.jl
+site_description: Finite Element Method solver
+site_author: ahojukka5
+
+theme: readthedocs
+
+extra_css:
+    - assets/Documenter.css
+
+extra_javascript:
+    - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
+    - assets/mathjaxhelper.js
+
+markdown_extensions:
+    - extra
+    - tables
+    - fenced_code
+    - footnotes
+    - mdx_math:
+        enable_dollar_delimiter: True
+
+docs_dir: 'build'
+
+pages:
+    - Home: index.md

docs/src/index.md

@@ -0,0 +1,24 @@
+# JuliaFEM.jl documentation
+
+```@contents
+```
+
+```@meta
+DocTestSetup = quote
+    using JuliaFEM
+end
+```
+
+## Constants
+
+Add here.
+
+## Functions
+
+Add here.
+
+## Index
+
+```@index
+```
+

test/run_lint.jl

@@ -0,0 +1,17 @@
+# This file is a part of JuliaFEM.
+# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE.md
+
+using Lint
+using Base.Test
+
+results = lintpkg("JuliaFEM")
+if !isempty(results)
+    info("Lint.jl is a tool that uses static analysis to assist in the development process by detecting common bugs and potential issues.")
+    info("For this package, Lint.jl report is following:")
+    display(results)
+    info("For more information, see https://lintjl.readthedocs.io/en/stable/")
+    warn("Package syntax test has failed.")
+    @test isempty(results)
+else
+    info("Lint.jl: syntax check pass.")
+end