Merge pull request #946 from baronfel/docs-url-fixes

baronfel · web-flow · commit 6d6e97f277ef · 2020-06-10T17:00:09.000-05:00
set the root url to be scheme-less for local dev, and fix api reference urls to the way they used to be
diff --git a/fcs/docsrc/generators/apiref.fsx b/fcs/docsrc/generators/apiref.fsx
@@ -258,24 +258,21 @@ let generateNamespace ctx (n: Namespace)  =
 
 
 let generate' (ctx : SiteContents)  =
-    let all = ctx.TryGetValues<AssemblyEntities>()
+    let all = ctx.TryGetValue<AssemblyEntities>()
     match all with
     | None -> []
-    | Some all ->
-      all
-      |> Seq.toList
-      |> List.collect (fun n ->
-        let name = n.GeneratorOutput.AssemblyGroup.Name
+    | Some assyEntities ->
+        let name = assyEntities.GeneratorOutput.AssemblyGroup.Name
         let namespaces =
-          n.GeneratorOutput.AssemblyGroup.Namespaces
+          assyEntities.GeneratorOutput.AssemblyGroup.Namespaces
           |> List.map (generateNamespace ctx)
 
         let modules =
-          n.Modules
+          assyEntities.Modules
           |> Seq.map (generateModule ctx)
 
         let types =
-          n.Types
+          assyEntities.Types
           |> Seq.map (generateType ctx)
 
         let ref =
@@ -286,11 +283,9 @@ let generate' (ctx : SiteContents)  =
             for (n, _) in namespaces do
                 a [Href (sprintf "%s.html"  n)] [!!n]
                 br []
-          ] n.Label
+          ] assyEntities.Label
 
         [("index" , ref); yield! namespaces; yield! modules; yield! types]
-        |> List.map (fun (x, y) -> (sprintf "%s/%s" n.Label x), y)
-      )
 
 
 let generate (ctx : SiteContents) (projectRoot: string) (page: string) =
diff --git a/fcs/docsrc/generators/lunr.fsx b/fcs/docsrc/generators/lunr.fsx
@@ -27,25 +27,22 @@ let generate (ctx : SiteContents) (projectRoot: string) (page: string) =
         let entries =
           pages
           |> Seq.map (fun n ->
-              {uri = rootUrl + "/" + n.link.Replace("content/", ""); title = n.title; content = n.text}
+              {uri = rootUrl.subRoute (n.link.Replace("content/", "")); title = n.title; content = n.text}
           )
 
-        let all = ctx.TryGetValues<AssemblyEntities>()
+        let all = ctx.TryGetValue<AssemblyEntities>()
         let refs =
           match all with
           | None -> []
-          | Some all ->
-            all
-            |> Seq.toList
-            |> List.collect (fun n ->
-              let generatorOutput = n.GeneratorOutput
-              let allModules = n.Modules
-              let allTypes = n.Types
+          | Some assembyEntities ->
+              let generatorOutput = assembyEntities.GeneratorOutput
+              let allModules = assembyEntities.Modules
+              let allTypes = assembyEntities.Types
 
               let gen =
                   let ctn =
                       sprintf "%s \n %s" generatorOutput.AssemblyGroup.Name (generatorOutput.AssemblyGroup.Namespaces |> Seq.map (fun n -> n.Name) |> String.concat " ")
-                  {uri = (rootUrl + sprintf "/reference/%s/index.html" n.Label ); title = sprintf "%s - API Reference" n.Label; content = ctn }
+                  {uri = (rootUrl.subRoute "/reference/index.html"); title = sprintf "%s - API Reference" assembyEntities.Label; content = ctn }
 
               let mdlsGen =
                   allModules
@@ -61,7 +58,7 @@ let generate (ctx : SiteContents) (projectRoot: string) (page: string) =
                               (m.TypeExtensions |> List.map (fun m -> m.Name + " " + m.Comment.FullText ) |> String.concat " ")
 
 
-                      {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label m.UrlName ; title = m.Name; content = cnt }
+                      {uri = rootUrl.subRoutef "/reference/%s.html" m.UrlName ; title = m.Name; content = cnt }
                   )
 
               let tsGen =
@@ -75,10 +72,10 @@ let generate (ctx : SiteContents) (projectRoot: string) (page: string) =
                               (m.AllMembers |> List.map (fun m -> m.Name + " " + m.Comment.FullText ) |> String.concat " ")
 
 
-                      {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label m.UrlName ; title = m.Name; content = cnt }
+                      {uri = rootUrl.subRoutef "/reference/%s.html" m.UrlName ; title = m.Name; content = cnt }
                   )
               [yield! entries; gen; yield! mdlsGen; yield! tsGen]
-            )
+              
         printfn "generated search index"
         [|yield! entries; yield! refs|]
         |> Newtonsoft.Json.JsonConvert.SerializeObject
diff --git a/fcs/docsrc/generators/partials/footer.fsx b/fcs/docsrc/generators/partials/footer.fsx
@@ -17,22 +17,21 @@ let footer (ctx : SiteContents)  =
         div [Custom("style", "left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;")] [
             div [Custom("style", "border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;")] []
         ]
-        script [Src (rootUrl + "/static/js/clipboard.min.js")] []
-        script [Src (rootUrl + "/static/js/perfect-scrollbar.min.js")] []
-        script [Src (rootUrl + "/static/js/perfect-scrollbar.jquery.min.js")] []
-        script [Src (rootUrl + "/static/js/jquery.sticky.js")] []
-        script [Src (rootUrl + "/static/js/featherlight.min.js")] []
-
-        script [Src (rootUrl + "/static/js/modernizr.custom-3.6.0.js")] []
-        script [Src (rootUrl + "/static/js/learn.js")] []
-        script [Src (rootUrl + "/static/js/hugo-learn.js")] []
-        link [Rel "stylesheet"; Href (rootUrl + "/static/mermaid/mermaid.css")]
-        script [Src (rootUrl + "/static/mermaid/mermaid.js")] []
+        script [Src (rootUrl.subRoute "/static/js/clipboard.min.js")] []
+        script [Src (rootUrl.subRoute "/static/js/perfect-scrollbar.min.js")] []
+        script [Src (rootUrl.subRoute "/static/js/perfect-scrollbar.jquery.min.js")] []
+        script [Src (rootUrl.subRoute "/static/js/jquery.sticky.js")] []
+        script [Src (rootUrl.subRoute "/static/js/featherlight.min.js")] []
+        script [Src (rootUrl.subRoute "/static/js/modernizr.custom-3.6.0.js")] []
+        script [Src (rootUrl.subRoute "/static/js/learn.js")] []
+        script [Src (rootUrl.subRoute "/static/js/hugo-learn.js")] []
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/mermaid/mermaid.css")]
+        script [Src (rootUrl.subRoute "/static/mermaid/mermaid.js")] []
         script [] [!! "mermaid.initialize({ startOnLoad: true });"]
-        script [Src "//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.0/highlight.min.js"] []
-        script [Src "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.0/languages/fsharp.min.js"] []
+        script [Src "////cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.0/highlight.min.js"] []
+        script [Src "//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.0/languages/fsharp.min.js"] []
         script [] [
           !! "hljs.initHighlightingOnLoad()"
         ]
-        script [Src (rootUrl + "/static/js/tips.js")] []
+        script [Src (rootUrl.subRoute "/static/js/tips.js")] []
     ]
diff --git a/fcs/docsrc/generators/partials/header.fsx b/fcs/docsrc/generators/partials/header.fsx
@@ -15,18 +15,17 @@ let header (ctx : SiteContents) page =
         meta [CharSet "utf-8"]
         meta [Name "viewport"; Content "width=device-width, initial-scale=1"]
         title [] [!! (siteInfo.title + " | " + page)]
-        link [Rel "icon"; Type "image/png"; Sizes "32x32"; Href (rootUrl + "/static/images/favicon.png")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/nucleus.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/fontawesome-all.min.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/hybrid.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/featherlight.min.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/perfect-scrollbar.min.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/auto-complete.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/atom-one-dark-reasonable.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/theme.css")]
-        link [Rel "stylesheet"; Href (rootUrl + "/static/css/tips.css")]
+        link [Rel "icon"; Type "image/png"; Sizes "32x32"; Href (rootUrl.subRoute "/static/images/favicon.png")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/nucleus.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/fontawesome-all.min.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/hybrid.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/featherlight.min.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/perfect-scrollbar.min.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/auto-complete.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/atom-one-dark-reasonable.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/theme.css")]
+        link [Rel "stylesheet"; Href (rootUrl.subRoute "/static/css/tips.css")]
         link [Rel "stylesheet"; Href "//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.0/styles/atom-one-dark.min.css"]
-        if siteInfo.theme_variant.IsSome then
-            link [Rel "stylesheet"; Href (rootUrl + (sprintf "/static/css/theme-%s.css" siteInfo.theme_variant.Value))]
-        script [Src (rootUrl + "/static/js/jquery-3.3.1.min.js")] []
+        link [Rel "stylesheet"; Href (rootUrl.subRoutef "/static/css/theme-%s.css" ((siteInfo.theme_variant.ToString().ToLower()))) ]
+        script [Src (rootUrl.subRoute "/static/js/jquery-3.3.1.min.js")] []
     ]
diff --git a/fcs/docsrc/generators/partials/menu.fsx b/fcs/docsrc/generators/partials/menu.fsx
@@ -11,7 +11,7 @@ open Html
 
 let menu (ctx : SiteContents) (page: string) =
   let shortcuts = ctx.GetValues<Pageloader.Shortcut> ()
-  let all = ctx.GetValues<Apirefloader.AssemblyEntities>()
+  let apiRef = ctx.TryGetValue<Apirefloader.AssemblyEntities>()
 
   let content = ctx.GetValues<Contentloader.Post> ()
   let siteInfo = ctx.TryGetValue<Globalloader.SiteInfo>().Value
@@ -24,7 +24,7 @@ let menu (ctx : SiteContents) (page: string) =
 
   let group = content |> Seq.tryFind (fun n -> n.title = page) |> Option.map (fun n -> n.category)
 
-  let explenations =
+  let explanations =
     content
     |> Seq.filter (fun n -> n.category = Contentloader.Explanation && not n.hide_menu && n.language = language )
     |> Seq.sortBy (fun n -> n.menu_order)
@@ -40,12 +40,12 @@ let menu (ctx : SiteContents) (page: string) =
     |> Seq.sortBy (fun n -> n.menu_order)
 
   let hasTutorials = not (Seq.isEmpty tutorials)
-  let hasExplenations = not (Seq.isEmpty explenations)
+  let hasExplanations = not (Seq.isEmpty explanations)
   let hasHowTos = not (Seq.isEmpty howtos)
 
   let menuHeader =
     [
-      if hasExplenations then
+      if hasExplanations then
         li [Id "menu-explanations"; if group = Some Contentloader.Explanation then Class "dd-item menu-group-link menu-group-link-active" else  Class "dd-item menu-group-link"; ] [
           a [] [!! "Explanation"]
         ]
@@ -58,15 +58,15 @@ let menu (ctx : SiteContents) (page: string) =
           a [] [!! "How-To Guides"]
         ]
       li [ Id "menu-refs"; if group = None then Class "dd-item menu-group-link menu-group-link-active" else Class "dd-item menu-group-link";] [
-        a [] [!! "API References"]
+        a [Href (rootUrl.subRoute "/reference/index.html")] [!! "API Reference"]
       ]
     ]
 
   let renderExpls =
     ul [Id "submenu-explanations"; if group = Some Contentloader.Explanation then Class "submenu submenu-active" else Class "submenu"; ] [
-      for r in explenations ->
+      for r in explanations ->
         li [] [
-          a [Href (rootUrl + "/" +  r.link); if r.title = page then Class "active-link padding" else Class "padding"] [
+          a [Href (rootUrl.subRoute r.link); if r.title = page then Class "active-link padding" else Class "padding"] [
             !! r.title
           ]
         ]
@@ -76,7 +76,7 @@ let menu (ctx : SiteContents) (page: string) =
     ul [Id "submenu-tutorials"; if group = Some Contentloader.Tutorial then Class "submenu submenu-active" else Class "submenu"; ] [
       for r in tutorials ->
         li [] [
-          a [ Href (rootUrl + "/" + r.link); if r.title = page then Class "active-link padding" else Class "padding" ] [
+          a [ Href (rootUrl.subRoute r.link); if r.title = page then Class "active-link padding" else Class "padding" ] [
             !! r.title
           ]
         ]
@@ -86,33 +86,23 @@ let menu (ctx : SiteContents) (page: string) =
     ul [Id "submenu-howtos"; if group = Some Contentloader.HowTo then Class "submenu submenu-active" else Class "submenu"; ] [
       for r in howtos ->
         li [] [
-          a [Href (rootUrl + "/" +  r.link); if r.title = page then Class "active-link padding" else Class "padding" ] [
+          a [Href (rootUrl.subRoute r.link); if r.title = page then Class "active-link padding" else Class "padding" ] [
             !! r.title
           ]
         ]
     ]
 
-  let renderRefs =
-    ul [Id "submenu-refs"; if group = None then Class "submenu submenu-active" else Class "submenu"; ] [
-      for r in all ->
-        li [] [
-          a [Href (rootUrl + "/reference/" +  r.Label + "/index.html"); if r.Label = page then Class "active-link padding" else Class "padding" ] [
-            !! r.Label
-          ]
-        ]
-    ]
-
   let renderLanguages =
     section [Id "languages"] [
         h3 [] [!! "Languages"]
         ul [] [
           li [] [
-            a [Href (rootUrl + "/index.html"); if language = None then Class "menu-group-link-active padding" else Class "padding" ] [
+            a [Href (rootUrl.subRoute "/index.html"); if language = None then Class "menu-group-link-active padding" else Class "padding" ] [
             !! "English"
             ]
           ]
           li [] [
-            a [Href (rootUrl + "/ja/index.html"); if language = Some "ja" then Class "menu-group-link-active padding" else Class "padding" ] [
+            a [Href (rootUrl.subRoute "/ja/index.html"); if language = Some "ja" then Class "menu-group-link-active padding" else Class "padding" ] [
             !! "Japanese"
             ]
           ]
@@ -121,7 +111,7 @@ let menu (ctx : SiteContents) (page: string) =
 
   let renderShortucuts =
     section [Id "shortcuts"] [
-        h3 [] [!! "Shortucts"]
+        h3 [] [!! "Shortcuts"]
         ul [] [
           for s in shortcuts do
             yield
@@ -150,17 +140,16 @@ let menu (ctx : SiteContents) (page: string) =
         input [Custom ("data-search-input", ""); Id "search-by"; Type "search"; Placeholder "Search..."]
         span  [Custom ("data-search-clear", "")] [i [Class "fas fa-times"] []]
       ]
-      script [Type "text/javascript"; Src (rootUrl + "/static/js/lunr.min.js")] []
-      script [Type "text/javascript"; Src (rootUrl + "/static/js/auto-complete.js")] []
-      script [Type "text/javascript";] [!! (sprintf "var baseurl ='%s'" rootUrl)]
-      script [Type "text/javascript"; Src (rootUrl + "/static/js/search.js")] []
+      script [Type "text/javascript"; Src (rootUrl.subRoute "/static/js/lunr.min.js")] []
+      script [Type "text/javascript"; Src (rootUrl.subRoute "/static/js/auto-complete.js")] []
+      script [Type "text/javascript";] [!! (sprintf "var baseurl ='%s'" (rootUrl.subRoute "")) ]
+      script [Type "text/javascript"; Src (rootUrl.subRoute "/static/js/search.js")] []
     ]
     div [Class "highlightable"] [
       ul [Class "topics"] menuHeader
-      if hasExplenations then renderExpls
+      if hasExplanations then renderExpls
       if hasTutorials then renderTuts
       if hasHowTos then renderHowTos
-      renderRefs
       renderLanguages
       renderShortucuts
       renderFooter
diff --git a/fcs/docsrc/loaders/apirefloader.fsx b/fcs/docsrc/loaders/apirefloader.fsx
@@ -29,44 +29,40 @@ let rec collectModules pn pu nn nu (m: Module) =
 
 let loader (projectRoot: string) (siteContent: SiteContents) =
     try
-      let dlls =
-        [
-          "FSharp.Compiler.Service", Path.Combine(projectRoot, "..", "..", "artifacts", "bin", "fcs", "Release", "netcoreapp3.0", "FSharp.Compiler.Service.dll")
-        ]
-      let libs =
-        [
-          Path.Combine(projectRoot, "..", "..", "artifacts", "bin", "fcs", "Release", "netcoreapp3.0")
-        ]
-      for (label, dll) in dlls do
-        printfn "generating api ref for %s at %s" label dll
+      let label = "FSharp.Compiler.Service"
+      let dll = Path.Combine(projectRoot, "..", "..", "artifacts", "bin", "fcs", "Release", "netcoreapp3.0", "FSharp.Compiler.Service.dll")
+      let libs = Path.Combine(projectRoot, "..", "..", "artifacts", "bin", "fcs", "Release", "netcoreapp3.0")
 
-        let output = MetadataFormat.Generate(dll, markDownComments = true, publicOnly = true, libDirs = libs)
+      printfn "generating api ref for %s at %s" label dll
 
-        let allModules =
-            output.AssemblyGroup.Namespaces
-            |> List.collect (fun n ->
-                List.collect (collectModules n.Name n.Name n.Name n.Name) n.Modules
-            )
+      let output = MetadataFormat.Generate(dll, markDownComments = true, publicOnly = true, libDirs = [libs])
 
-        let allTypes =
-            [
-                yield!
-                    output.AssemblyGroup.Namespaces
-                    |> List.collect (fun n ->
-                        n.Types |> List.map (fun t -> {ParentName = n.Name; ParentUrlName = n.Name; NamespaceName = n.Name; NamespaceUrlName = n.Name; Info = t} )
-                    )
-                yield!
-                    allModules
-                    |> List.collect (fun n ->
-                        n.Info.NestedTypes |> List.map (fun t -> {ParentName = n.Info.Name; ParentUrlName = n.Info.UrlName; NamespaceName = n.NamespaceName; NamespaceUrlName = n.NamespaceUrlName; Info = t}) )
-            ]
-        let entities = {
-          Label = label
-          Modules = allModules
-          Types = allTypes
-          GeneratorOutput = output
-        }
-        siteContent.Add entities
+      let allModules =
+          output.AssemblyGroup.Namespaces
+          |> List.collect (fun n ->
+              List.collect (collectModules n.Name n.Name n.Name n.Name) n.Modules
+          )
+
+      let allTypes =
+          [
+              yield!
+                  output.AssemblyGroup.Namespaces
+                  |> List.collect (fun n ->
+                      n.Types |> List.map (fun t -> {ParentName = n.Name; ParentUrlName = n.Name; NamespaceName = n.Name; NamespaceUrlName = n.Name; Info = t} )
+                  )
+              yield!
+                  allModules
+                  |> List.collect (fun n ->
+                      n.Info.NestedTypes |> List.map (fun t -> {ParentName = n.Info.Name; ParentUrlName = n.Info.UrlName; NamespaceName = n.NamespaceName; NamespaceUrlName = n.NamespaceUrlName; Info = t}) )
+          ]
+      let entities = {
+        Label = label
+        Modules = allModules
+        Types = allTypes
+        GeneratorOutput = output
+      }
+      siteContent.Add entities
+      printfn "generated api ref for %s at %s" label dll
     with
     | ex ->
       printfn "%A" ex
diff --git a/fcs/docsrc/loaders/globalloader.fsx b/fcs/docsrc/loaders/globalloader.fsx
