rename legacyAPILayout to apiSubdirectory

Author: romanowski

project/Build.scala

@@ -1355,7 +1355,7 @@ object Build {
               s"-source-links:docs=github://lampepfl/dotty/master#docs",
               "-doc-root-content", docRootFile.toString,
               "-Ydocument-synthetic-types"
-            ) ++ (if (justAPI) Nil else Seq("-siteroot", "docs", "-Ylegacy-api-layout")))
+            ) ++ (if (justAPI) Nil else Seq("-siteroot", "docs", "-Yapi-subdirectory")))
 
         if (dottyJars.isEmpty) Def.task { streams.value.log.error("Dotty lib wasn't found") }
         else if (justAPI) generateDocTask

scaladoc/src/dotty/tools/scaladoc/Scaladoc.scala

@@ -59,7 +59,7 @@ object Scaladoc:
     noLinkWarnings: Boolean = false,
     versionsDictionaryUrl: Option[String] = None,
     generateInkuire : Boolean = false,
-    legacyAPILayout : Boolean = false
+    apiSubdirectory : Boolean = false
   )
 
   def run(args: Array[String], rootContext: CompilerContext): Reporter =
@@ -225,7 +225,7 @@ object Scaladoc:
         snippetCompilerDebug.get,
         versionsDictionaryUrl.nonDefault,
         generateInkuire.get,
-        legacyAPILayout.get,
+        apiSubdirectory.get,
       )
       (Some(docArgs), newContext)
     }

scaladoc/src/dotty/tools/scaladoc/ScaladocSettings.scala

@@ -120,8 +120,8 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
   val generateInkuire: Setting[Boolean] =
     BooleanSetting("-Ygenerate-inkuire", "Generates InkuireDB and enables Hoogle-like searches", false)
 
-  val legacyAPILayout: Setting[Boolean] =
-    BooleanSetting("-Ylegacy-api-layout", "Keep all api member inside `api` directory", false)
+  val apiSubdirectory: Setting[Boolean] =
+    BooleanSetting("-Yapi-subdirectory", "Keep all api member inside `api` directory", false)
 
   def scaladocSpecificSettings: Set[Setting[_]] =
     Set(sourceLinks, syntax, revision, externalDocumentationMappings, socialLinks, skipById, skipByRegex, deprecatedSkipPackages, docRootContent, snippetCompiler, snippetCompilerDebug, generateInkuire)

scaladoc/src/dotty/tools/scaladoc/renderers/HtmlRenderer.scala

@@ -58,8 +58,14 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
 
   val hiddenPages: Seq[Page] =
     staticSite match
-      case None => Nil
+      case None =>
+        Seq(navigablePage.copy( // Add index page that is a copy of api/index.html
+          link = navigablePage.link.copy(dri = docsRootDRI),
+          children = Nil
+        ))
       case Some(siteContext) =>
+        // In case that we do not have an index page and we do not have any API entries 
+        // we want to create empty index page, so there is one
         val actualIndexTemplate = siteContext.indexTemplates() match
           case Nil if effectiveMembers.isEmpty => Seq(siteContext.emptyIndexTemplate)
           case templates => templates

scaladoc/src/dotty/tools/scaladoc/renderers/Locations.scala

@@ -26,7 +26,7 @@ trait Locations(using ctx: DocContext):
   var cache = new JHashMap[DRI, Seq[String]]()
 
   private[renderers] def pathsConflictResoultionMsg =
-    "Using `-Ylegacy-api-layout` flag will move all API documentaiton into `api` subdirectory and will fix this conflict."
+    "Using `-Yapi-subdirectory` flag will move all API documentation into `api` subdirectory and will fix this conflict."
 
   // TODO verify if location exisits
   def rawLocation(dri: DRI): Seq[String] =
@@ -35,7 +35,7 @@ trait Locations(using ctx: DocContext):
         val path = dri match
           case `docsRootDRI` => List("docs", "index")
           case `apiPageDRI` =>
-            if ctx.args.legacyAPILayout || ctx.staticSiteContext.fold(false)(_.hasIndexFile)
+            if ctx.args.apiSubdirectory || ctx.staticSiteContext.fold(false)(_.hasIndexFile)
               then List("api", "index")
               else List("index")
           case dri if dri.isStaticFile =>
@@ -46,7 +46,7 @@ trait Locations(using ctx: DocContext):
               case "<empty>" :: Nil  => "_empty_" :: Nil
               case "<empty>" :: tail => "_empty_" :: tail
               case other => other
-            if ctx.args.legacyAPILayout then "api" :: fqn else fqn
+            if ctx.args.apiSubdirectory then "api" :: fqn else fqn
         cache.put(dri, path)
         path
       case cached => cached