Skip to content

Commit

Permalink
Clean up docs generation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtschelfthout committed May 25, 2014
1 parent 45e883b commit 02d4503
Show file tree
Hide file tree
Showing 16 changed files with 242 additions and 901 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ build/
[Bb]in/
[Oo]bj/
temp/
docs/output

# MSTest test Results
[Tt]est[Rr]esult*/
Expand Down
2 changes: 1 addition & 1 deletion License.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2008-2013, Kurt Schelfthout
Copyright (c) 2008-2014, Kurt Schelfthout
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Expand Down
12 changes: 9 additions & 3 deletions build.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -219,18 +219,24 @@ Target "Release" DoNothing

Target "All" DoNothing

Target "Docs" DoNothing

"Clean"
==> "RestorePackages"
==> "AssemblyInfo"
==> "Build"
==> "RunTests"
==> "All"

"Build"
==> "CleanDocs"
==> "GenerateDocs"
==> "Docs"
==> "All"

"All"
=?> ("SourceLink", isLocalBuild && not isLinux)
//==> "CleanDocs"
//==> "GenerateDocs"
//==> "ReleaseDocs"
==> "ReleaseDocs"
==> "NuGet"
==> "Release"

Expand Down
11 changes: 5 additions & 6 deletions build.ps1
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
cls
If (-Not (Test-Path packages\FAKE\tools\Fake.exe)) {
.nuget\nuget.exe install FAKE -OutputDirectory packages -ExcludeVersion
}
If (-Not (Test-Path packages\SourceLink.Fake\tools\SourceLink.fsx)) {
.nuget\nuget.exe install SourceLink.Fake -OutputDirectory packages -ExcludeVersion
}

.nuget\nuget.exe install FAKE -OutputDirectory packages -ExcludeVersion
.nuget\nuget.exe install SourceLink.Fake -OutputDirectory packages -ExcludeVersion
.nuget\nuget.exe install FSharp.Formatting -OutputDirectory packages -ExcludeVersion

packages\FAKE\tools\FAKE.exe build.fsx $args
2 changes: 1 addition & 1 deletion docs/Properties.fsx → docs/content/Properties.fsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(*** hide ***)
#I "../FsCheck/bin/Debug"
#I "../../src/FsCheck/bin/Release"
#r "FsCheck"

open FsCheck
Expand Down
2 changes: 1 addition & 1 deletion docs/QuickStart.fsx → docs/content/QuickStart.fsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(*** hide ***)
#I "../FsCheck/bin/Debug"
#I "../../src/FsCheck/bin/Release"
#r "FsCheck"

open FsCheck
Expand Down
66 changes: 66 additions & 0 deletions docs/content/index.fsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
(*** hide ***)
// This block of code is omitted in the generated HTML documentation. Use
// it to define helpers that you do not want to show in the documentation.
#I "../../src/FsCheck/bin/Release"

(**
FsCheck
=======
<div class="row">
<div class="span1"></div>
<div class="span6">
<div class="well well-small" id="nuget">
FsCheck and xUnit.NET plugin can be <a href="https://nuget.org/packages/FsCheck">installed from NuGet</a>:
<pre>PM> Install-Package FsCheck
PM> Install-Package FsCheck.Xunit</pre>
</div>
</div>
<div class="span1"></div>
</div>
Example
-------
This example demonstrates using a function defined in this sample library.
*)
#r "FsCheck.dll"
open FsCheck

//printfn "hello = %i" <| Library.hello 0

(**
Some more info
Samples & documentation
-----------------------
The library comes with comprehensive documentation.
It can include a tutorials automatically generated from `*.fsx` files in [the content folder][content].
The API reference is automatically generated from Markdown comments in the library implementation.
* [QuickStart](QuickStart.html) contains a further explanation of this sample library.
* [API Reference](reference/index.html) contains automatically generated documentation for all types, modules
and functions in the library. This includes additional brief samples on using most of the
functions.
Contributing and copyright
--------------------------
The project is hosted on [GitHub][gh] where you can [report issues][issues], fork
the project and submit pull requests. If you're adding new public API, please also
consider adding [samples][content] that can be turned into documentation. You might
also want to read [library design notes][readme] to understand how it works.
The library is available under the BSD license, which allows modification and
redistribution for both commercial and non-commercial purposes. For more information see the
[License file][license] in the GitHub repository.
[content]: https://github.com/fsharp/FsCheck/tree/master/docs/content
[gh]: https://github.com/fsharp/FsCheck
[issues]: https://github.com/fsharp/FsCheck/issues
[readme]: https://github.com/fsharp/FsCheck/blob/master/README.md
[license]: https://github.com/fsharp/FsCheck/blob/master/LICENSE.txt
*)
Binary file added docs/files/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
424 changes: 0 additions & 424 deletions docs/output/Properties.html

This file was deleted.

171 changes: 0 additions & 171 deletions docs/output/QuickStart.html

This file was deleted.

197 changes: 0 additions & 197 deletions docs/output/content/style.css

This file was deleted.

35 changes: 0 additions & 35 deletions docs/templates/template-file.html

This file was deleted.

Loading

0 comments on commit 02d4503

Please sign in to comment.