Initial Documenter docs - docs build fails for now

domluna · Oct 26, 2019 · 3d1bf26 · 3d1bf26
1 parent ad2b4dd
commit 3d1bf26
Show file tree

Hide file tree

Showing 9 changed files with 495 additions and 1 deletion.
diff --git a/.travis.yml b/.travis.yml
@@ -15,7 +15,20 @@ matrix:
   fast_finish: true
 notifications:
   email: false
+
 script:
   - julia --color=yes -e 'using Pkg; Pkg.activate(); Pkg.instantiate(); Pkg.test()'
+
+
 # after_success:
 #   - julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder())'
+
+# jobs:
+#   include:
+#     - stage: "Documentation"
+#       julia: 1.3
+#       os: linux
+#       script:
+#         - docs/make.jl
+#       after_success: skip
+
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # JuliaFormatter.jl
 
 [![Build Status](https://travis-ci.org/domluna/JuliaFormatter.jl.svg?branch=master)](https://travis-ci.org/domluna/JuliaFormatter.jl)
-<!-- [![Coverage Status](https://coveralls.io/repos/github/domluna/JuliaFormatter.jl/badge.svg?branch=master)](https://coveralls.io/github/domluna/JuliaFormatter.jl?branch=master) -->
 
 Width-sensitive formatter for Julia code. Inspired by gofmt and refmt.
 

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+build
diff --git a/docs/Manifest.toml b/docs/Manifest.toml
@@ -0,0 +1,109 @@
+# This file is machine-generated - editing it directly is not advised
+
+[[Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+
+[[CSTParser]]
+deps = ["Tokenize"]
+git-tree-sha1 = "c69698c3d4a7255bc1b4bc2afc09f59db910243b"
+uuid = "00ebfdb7-1f24-5e51-bd34-a7502290713f"
+version = "0.6.2"
+
+[[Dates]]
+deps = ["Printf"]
+uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
+
+[[Distributed]]
+deps = ["Random", "Serialization", "Sockets"]
+uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
+
+[[DocStringExtensions]]
+deps = ["LibGit2", "Markdown", "Pkg", "Test"]
+git-tree-sha1 = "88bb0edb352b16608036faadcc071adda068582a"
+uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+version = "0.8.1"
+
+[[Documenter]]
+deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
+git-tree-sha1 = "d45c163c7a3ae293c15361acc52882c0f853f97c"
+uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+version = "0.23.4"
+
+[[InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+
+[[JSON]]
+deps = ["Dates", "Mmap", "Parsers", "Unicode"]
+git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e"
+uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+version = "0.21.0"
+
+[[JuliaFormatter]]
+deps = ["CSTParser", "Test", "Tokenize"]
+git-tree-sha1 = "7ad0fb4dcce2e6b13ffaa56f4217391bf71969d6"
+uuid = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
+version = "0.1.16"
+
+[[LibGit2]]
+uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
+
+[[Libdl]]
+uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+
+[[Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+
+[[Markdown]]
+deps = ["Base64"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+
+[[Mmap]]
+uuid = "a63ad114-7e13-5084-954f-fe012c677804"
+
+[[Parsers]]
+deps = ["Dates", "Test"]
+git-tree-sha1 = "ef0af6c8601db18c282d092ccbd2f01f3f0cd70b"
+uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
+version = "0.3.7"
+
+[[Pkg]]
+deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
+uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+
+[[Printf]]
+deps = ["Unicode"]
+uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[[REPL]]
+deps = ["InteractiveUtils", "Markdown", "Sockets"]
+uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
+
+[[Random]]
+deps = ["Serialization"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[[SHA]]
+uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+
+[[Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+
+[[Sockets]]
+uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[[Test]]
+deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
+uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[[Tokenize]]
+git-tree-sha1 = "dfcdbbfb2d0370716c815cbd6f8a364efb6f42cf"
+uuid = "0796e94c-ce3b-5d07-9a54-7f471281c624"
+version = "0.5.6"
+
+[[UUIDs]]
+deps = ["Random", "SHA"]
+uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+
+[[Unicode]]
+uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,13 @@
+using Documenter, JuliaFormatter
+
+makedocs(
+    sitename = "JuliaFormatter",
+    modules = [JuliaFormatter],
+    pages = [
+        "Introduction" => "index.md",
+        "Code Style" => "style.md",
+        "Syntax Transforms" => "transforms.md",
+    ],
+)
+
+deploydocs(repo = "github.com/domluna/JuliaFormatter.jl.git")
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,57 @@
+# JuliaFormatter.jl
+
+[![Build Status](https://travis-ci.org/domluna/JuliaFormatter.jl.svg?branch=master)](https://travis-ci.org/domluna/JuliaFormatter.jl)
+
+Width-sensitive formatter for Julia code. Inspired by gofmt, refmt, and black built with [`CSTParser`](https://github.com/ZacLN/CSTParser.jl).
+
+## Installation
+
+```julia
+]add JuliaFormatter
+```
+
+## Usage
+
+`JuliaFormatter` exports `format_text`, `format_file` and `format`:
+
+```julia
+format_text(
+    text::AbstractString;
+    indent = 4,
+    margin = 92,
+    always_for_in = false,
+)
+
+format_file(
+    file::AbstractString;
+    indent = 4,
+    margin = 92,
+    overwrite = true,
+    verbose = false,
+    always_for_in = false,
+)
+
+format(
+    paths...;
+    indent = 4,
+    margin = 92,
+    overwrite = true,
+    verbose = false,
+    always_for_in = false,
+)
+```
+
+The `text` argument to `format_text` is a string containing the code to be formatted; the formatted code is retuned as a new string. The `file` argument to `format_file` is the path of a file to be formatted. The `format` function is either called with a singe string to format if it is a `.jl` file or to recuse into looking for `.jl` files if it is a directory. It can also be called with a collection of such paths to iterate over.
+
+*Options:*
+
+* `indent` - The number of spaces used for an indentation.
+* `margin` - The maximum number of characters of code on a single line. Lines over
+the limit will be wrapped if possible. There are cases where lines cannot be wrapped
+and they will still end up wider than the requested margin.
+* `overwrite` - If the file should be overwritten by the formatted output. If set to false, the formatted version of file named `foo.jl` will be written to `foo_fmt.jl`.
+* `verbose` - Whether to print the name of the file being formatted along with relevant details to `stdout`.
+* `always_for_in` - Always use `in` keyword for `for` loops. This defaults to `false`.
+
+There is also a command-line tool `bin/format.jl` which can be invoked with `-i`/`--indent` and `-m`/`--margin` and with paths which will be passed to `format`.
+