Flux.jl/docs/make.jl

using Documenter, Flux, NNlib

DocMeta.setdocmeta!(Flux, :DocTestSetup, :(using Flux); recursive=true)
makedocs(modules=[Flux, NNlib],
         doctest = true,
         sitename = "Flux",
         format = Documenter.HTML(
                 analytics = "UA-36890222-9",
                 assets = ["assets/flux.css"],
                 prettyurls = get(ENV, "CI", nothing) == "true",
         ),
         pages = ["Home" => "index.md",
                  "Building Models" =>
                    ["Basics" => "models/basics.md",
                     "Recurrence" => "models/recurrence.md",
                     "Regularisation" => "models/regularisation.md",
                     "Model Reference" => "models/layers.md",
                     "Advanced Model Building" => "models/advanced.md",
                     "NNlib" => "models/nnlib.md"],
                  "Handling Data" =>
                    ["One-Hot Encoding" => "data/onehot.md",
                     "DataLoader" => "data/dataloader.md"],
                  "Training Models" =>
                    ["Optimisers" => "training/optimisers.md",
                     "Loss Functions" => "training/loss_functions.md",
                     "Training" => "training/training.md"],
                  "GPU Support" => "gpu.md",
                  "Saving & Loading" => "saving.md",
                  "The Julia Ecosystem" => "ecosystem.md",
                  "Utility Functions" => "utilities.md",
                  "Performance Tips" => "performance.md",
                  "Community" => "community.md"],
         )

deploydocs(repo = "github.com/FluxML/Flux.jl.git",
           target = "build",
           push_preview = true)
nnlib docs 2017-10-18 10:09:33 +00:00			`using Documenter, Flux, NNlib`
docs 2017-01-16 00:46:50 +00:00
Import (`using`) Flux for all doctests 2019-08-31 11:05:04 +00:00			`DocMeta.setdocmeta!(Flux, :DocTestSetup, :(using Flux); recursive=true)`
nnlib docs 2017-10-18 10:09:33 +00:00			`makedocs(modules=[Flux, NNlib],`
Update Documenter version and fix warnings 0.23.2 -> 0.23.3 2019-08-31 11:03:46 +00:00			`doctest = true,`
doc tweaks 2017-01-17 20:04:01 +00:00			`sitename = "Flux",`
Update Documenter version and fix warnings 0.23.2 -> 0.23.3 2019-08-31 11:03:46 +00:00			`format = Documenter.HTML(`
			`analytics = "UA-36890222-9",`
			`assets = ["assets/flux.css"],`
			`prettyurls = get(ENV, "CI", nothing) == "true",`
			`),`
style 2017-01-18 00:39:00 +00:00			`pages = ["Home" => "index.md",`
basic training docs 2017-09-10 01:01:19 +00:00			`"Building Models" =>`
model section 2017-09-07 05:49:46 +00:00			`["Basics" => "models/basics.md",`
layer docs 2017-09-08 21:52:41 +00:00			`"Recurrence" => "models/recurrence.md",`
document regularisation, fixes #160 2018-02-09 19:00:26 +00:00			`"Regularisation" => "models/regularisation.md",`
NNlib docs + misc docs improvements 2020-02-29 10:14:48 +00:00			`"Model Reference" => "models/layers.md",`
Merge branch 'master' into dg/params_docs 2020-03-02 07:15:30 +00:00			`"Advanced Model Building" => "models/advanced.md",`
NNlib docs + misc docs improvements 2020-02-29 10:14:48 +00:00			`"NNlib" => "models/nnlib.md"],`
add DataLoader special case train! for the unsupervised data iterator 2020-02-26 12:48:27 +00:00			`"Handling Data" =>`
			`["One-Hot Encoding" => "data/onehot.md",`
			`"DataLoader" => "data/dataloader.md"],`
basic training docs 2017-09-10 01:01:19 +00:00			`"Training Models" =>`
			`["Optimisers" => "training/optimisers.md",`
Add loss and utility functions to docs 2019-08-31 09:20:32 +00:00			`"Loss Functions" => "training/loss_functions.md",`
basic training docs 2017-09-10 01:01:19 +00:00			`"Training" => "training/training.md"],`
gpu support docs 2017-09-28 10:08:37 +00:00			`"GPU Support" => "gpu.md",`
model saving docs 2018-03-05 23:52:04 +00:00			`"Saving & Loading" => "saving.md",`
cleanup 2020-02-29 12:45:17 +00:00			`"The Julia Ecosystem" => "ecosystem.md",`
Add loss and utility functions to docs 2019-08-31 09:20:32 +00:00			`"Utility Functions" => "utilities.md",`
Create performance tips docs section (#615) * Create performance_tips.jl * Rename performance_tips.jl to performance_tips.md * add perf tips * Update docs/src/performance_tips.md Co-Authored-By: oxinabox <oxinabox@ucc.asn.au> * Update docs/src/performance_tips.md Co-Authored-By: oxinabox <oxinabox@ucc.asn.au> * Update make.jl * Update and rename performance_tips.md to performance.md * spelling * Update docs/src/performance.md Co-Authored-By: oxinabox <oxinabox@ucc.asn.au> * Update docs/src/performance.md Co-Authored-By: oxinabox <oxinabox@ucc.asn.au> * Update performance.md * Update performance.md * Update docs/src/performance.md Co-Authored-By: oxinabox <oxinabox@ucc.asn.au> * Update docs/src/performance.md Co-Authored-By: oxinabox <oxinabox@ucc.asn.au> 2019-02-19 15:03:41 +00:00			`"Performance Tips" => "performance.md",`
doc build changes 2019-08-19 14:49:50 +00:00			`"Community" => "community.md"],`
Update Documenter version and fix warnings 0.23.2 -> 0.23.3 2019-08-31 11:03:46 +00:00			`)`
docs 2017-01-16 00:46:50 +00:00
Update Documenter version and fix warnings 0.23.2 -> 0.23.3 2019-08-31 11:03:46 +00:00			`deploydocs(repo = "github.com/FluxML/Flux.jl.git",`
update documenter 2020-03-02 09:52:27 +00:00			`target = "build",`
			`push_preview = true)`