-
Notifications
You must be signed in to change notification settings - Fork 96
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Upgrade FSharp.Formatting / fsdocs #369
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
|
||
<head> | ||
<meta charset="utf-8"> | ||
<title>{{fsdocs-page-title}}</title> | ||
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> | ||
<meta name="author" content="{{fsdocs-authors}}"> | ||
|
||
<link rel="stylesheet" id="theme_link" href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/4.3.1/materia/bootstrap.min.css"> | ||
<script src="https://code.jquery.com/jquery-3.4.1.min.js"></script> | ||
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script> | ||
|
||
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> | ||
<!-- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script> --> | ||
|
||
<link type="text/css" rel="stylesheet" href="{{root}}content/navbar-fixed-left.css" /> | ||
<link type="text/css" rel="stylesheet" href="{{root}}content/fsdocs-default.css" /> | ||
<link type="text/css" rel="stylesheet" href="{{root}}content/fsdocs-custom.css" /> | ||
<script type="text/javascript" src="{{root}}content/fsdocs-tips.js"></script> | ||
<!-- HTML5 shim, for IE6-8 support of HTML5 elements --> | ||
<!--[if lt IE 9]> | ||
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> | ||
<![endif]--> | ||
<!-- BEGIN SEARCH BOX: this adds support for the search box --> | ||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" /> | ||
<!-- END SEARCH BOX: this adds support for the search box --> | ||
|
||
</head> | ||
|
||
<body> | ||
<nav class="navbar navbar-expand-md navbar-light bg-secondary fixed-left" id="fsdocs-menu"> | ||
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation"> | ||
<span class="navbar-toggler-icon"></span> | ||
</button> | ||
<div class="collapse navbar-collapse" id="navbarsExampleDefault"> | ||
<a href="{{fsdocs-logo-link}}"><img id="fsdocs-logo" src="{{fsdocs-logo-src}}" /></a> | ||
<!-- BEGIN SEARCH BOX: this adds support for the search box --> | ||
<div id="header"> | ||
<div class="searchbox" id="fsdocs-searchbox"> | ||
<label for="search-by"> | ||
<i class="fas fa-search"></i> | ||
</label> | ||
<input data-search-input="" id="search-by" type="search" placeholder="Search..." /> | ||
<span data-search-clear=""> | ||
<i class="fas fa-times"></i> | ||
</span> | ||
</div> | ||
</div> | ||
|
||
<!-- END SEARCH BOX: this adds support for the search box --> | ||
<ul class="navbar-nav"> | ||
<li class="nav-header">Links</li> | ||
<li class="nav-item" id="fsdocs-license-link"><a class="nav-link" href="{{fsdocs-license-link}}">License (Apache 2.0)</a></li> | ||
<li class="nav-item" id="fsdocs-release-notes-link"><a class="nav-link" href="{{fsdocs-release-notes-link}}">Release Notes</a></li> | ||
<li class="nav-item" id="fsdocs-repository-link"><a class="nav-link" href="{{fsdocs-repository-link}}">Source Repository</a></li> | ||
|
||
<!-- Do not use 'fsdocs-list-of-documents' which currently cannot be ordered, and dumps all files in docsrc/ --> | ||
<li class="nav-header" style="padding-top: 10px">Documentation</li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/tutorial.html">Tutorial</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/extensions.html">Extensions</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/generic-doc.html">Functions & Operators</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/types.html">Data Types</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/abstractions.html">Abstractions</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/computation-expressions.html">Computation Expressions</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/lens.html">Lens</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/parsing.html">Parsing</a></li> | ||
<li class="nav-item"><a class="nav-link" href="{{root}}/numerics.html">Numerics</a></li> | ||
|
||
{{fsdocs-list-of-namespaces}} | ||
</ul> | ||
</div> | ||
</nav> | ||
<div class="container"> | ||
<div class="masthead"> | ||
<h3 class="muted"><a href="{{fsdocs-collection-name-link}}">{{fsdocs-collection-name}}</a></h3> | ||
</div> | ||
<hr /> | ||
<div class="container" id="fsdocs-content"> | ||
{{fsdocs-content}} | ||
{{fsdocs-tooltips}} | ||
</div> | ||
|
||
<!-- BEGIN SEARCH BOX: this adds support for the search box --> | ||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" /> | ||
<script type="text/javascript">var fsdocs_search_baseurl = '{{root}}'</script> | ||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.8/lunr.min.js"></script> | ||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.min.js"></script> | ||
<script type="text/javascript" src="{{root}}content/fsdocs-search.js"></script> | ||
<!-- END SEARCH BOX: this adds support for the search box --> | ||
</div> | ||
</body> | ||
|
||
</html> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
(*** 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 "../../bin" | ||
#I "../bin" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can specify input to the tool in order to have another folder than the default. |
||
|
||
(** | ||
Alternative | ||
|
@@ -77,7 +77,7 @@ Examples | |
|
||
|
||
|
||
#r @"../../src/FSharpPlus/bin/Release/net45/FSharpPlus.dll" | ||
#r @"../src/FSharpPlus/bin/Release/net45/FSharpPlus.dll" | ||
|
||
open FSharpPlus | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docsrc/content/abstraction-arrow.fsx → docsrc/abstraction-arrow.fsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docsrc/content/abstraction-category.fsx → docsrc/abstraction-category.fsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The default template has
{{fsdocs-list-of-documents}}
but this doesn't work well, since it just lists all the files in docsrc/* and dumps them into the menu (so all the type-* files, and abstraction-*). A lot of them don't produce titles, and you can't order them.I decided to put these manually there and the result is pretty good:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks nice 👍