rename scala3doc into scaladoc

.github/workflows/scala3doc.yaml → .github/workflows/scaladoc.yaml

@@ -1,4 +1,4 @@
-name: Scala3doc
+name: scaladoc
 
 on:
   push:
@@ -12,7 +12,7 @@ jobs:
            && !contains(github.event.pull_request.body, '[skip ci]')
            && !contains(github.event.pull_request.body, '[skip docs]')
          )
-         || contains(github.event.ref, 'scala3doc')
+         || contains(github.event.ref, 'scaladoc')
          || contains(github.event.ref, 'master')"
 
     steps:
@@ -36,25 +36,25 @@ jobs:
           java-version: 11
 
       - name: Compile and test
-        run: ./project/scripts/sbt scala3doc/test
+        run: ./project/scripts/sbt scaladoc/test
 
       - name: Locally publish self
-        run: ./project/scripts/sbt scala3doc/publishLocal
+        run: ./project/scripts/sbt scaladoc/publishLocal
 
       - name: Generate self documentation
-        run: ./project/scripts/sbt scala3doc/generateSelfDocumentation
+        run: ./project/scripts/sbt scaladoc/generateSelfDocumentation
 
       - name: Generate testcases documentation
-        run: ./project/scripts/sbt scala3doc/generateTestcasesDocumentation
+        run: ./project/scripts/sbt scaladoc/generateTestcasesDocumentation
 
       - name: Generate Scala 3 documentation
-        run: ./project/scripts/sbt scala3doc/generateScala3Documentation
+        run: ./project/scripts/sbt scaladoc/generatescaladocumentation
 
       - name: Generate documentation for example project using dotty-sbt
-        run: ./project/scripts/sbt "sbt-dotty/scripted sbt-dotty/scala3doc"
+        run: ./project/scripts/sbt "sbt-dotty/scripted sbt-dotty/scaladoc"
 
       - name: Generate index file
-        run: scala3doc/scripts/mk-index.sh scala3doc/output > scala3doc/output/index.html
+        run: scaladoc/scripts/mk-index.sh scaladoc/output > scaladoc/output/index.html
 
       - name: Upload documentation to server
         uses: azure/CLI@v1
@@ -64,9 +64,9 @@ jobs:
         with:
           inlineScript: |
             DOC_DEST=pr-${PR_NUMBER:-${GITHUB_REF##*/}}
-            echo uplading docs to https://scala3doc.virtuslab.com/$DOC_DEST
-            az storage container create --name $DOC_DEST --account-name scala3docstorage --public-access container
-            az storage blob sync -s scala3doc/output -c $DOC_DEST --account-name scala3docstorage
+            echo uplading docs to https://scaladoc.virtuslab.com/$DOC_DEST
+            az storage container create --name $DOC_DEST --account-name scaladocstorage --public-access container
+            az storage blob sync -s scaladoc/output -c $DOC_DEST --account-name scaladocstorage
 
   community-docs:
     env:
@@ -76,7 +76,7 @@ jobs:
            && !contains(github.event.pull_request.body, '[skip ci]')
            && !contains(github.event.pull_request.body, '[skip docs]')
          )
-         || contains(github.event.ref, 'scala3doc')
+         || contains(github.event.ref, 'scaladoc')
          || contains(github.event.ref, 'master')"
 
     steps:
@@ -102,6 +102,6 @@ jobs:
         with:
           inlineScript: |
             DOC_DEST=pr-${PR_NUMBER:-${GITHUB_REF##*/}}-docs
-            echo uplading docs to https://scala3doc.virtuslab.com/$DOC_DEST
-            az storage container create --name $DOC_DEST --account-name scala3docstorage --public-access container
-            az storage blob sync -s community-build/docsOutput -c $DOC_DEST --account-name scala3docstorage
+            echo uplading docs to https://scaladoc.virtuslab.com/$DOC_DEST
+            az storage container create --name $DOC_DEST --account-name scaladocstorage --public-access container
+            az storage blob sync -s community-build/docsOutput -c $DOC_DEST --account-name scaladocstorage

build.sbt

@@ -20,9 +20,9 @@ val `stdlib-bootstrapped-tasty-tests` = Build.`stdlib-bootstrapped-tasty-tests`
 val `tasty-core` = Build.`tasty-core`
 val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped`
 val `tasty-core-scala2` = Build.`tasty-core-scala2`
-val scala3doc = Build.scala3doc
-val `scala3doc-testcases` = Build.`scala3doc-testcases`
-val `scala3doc-js` = Build.`scala3doc-js`
+val scaladoc = Build.scaladoc
+val `scaladoc-testcases` = Build.`scaladoc-testcases`
+val `scaladoc-js` = Build.`scaladoc-js`
 val `scala3-bench-run` = Build.`scala3-bench-run`
 val dist = Build.dist
 val `community-build` = Build.`community-build`

community-build/src/scala/dotty/communitybuild/Main.scala

@@ -12,7 +12,7 @@ object Main:
     val name = project.project
     try
       project.doc()
-      val pathsOut = s"find community-projects/$name/ -name 'scala3doc.version'".!!
+      val pathsOut = s"find community-projects/$name/ -name 'scaladoc.version'".!!
       pathsOut.linesIterator.map(Paths.get(_).getParent).toList
     catch
       case e: Exception =>

community-build/src/scala/dotty/communitybuild/projects.scala

@@ -162,12 +162,12 @@ final case class SbtCommunityProject(
 
   override val publishCommand = if sbtPublishCommand eq null then null else
     val disableDocCommand =
-      if sbtDocCommand eq null then "" else "set every useScala3doc := false;"
+      if sbtDocCommand eq null then "" else "set every usescaladoc := false;"
     s"$baseCommand$disableDocCommand$sbtPublishCommand"
   override val docCommand =
     if sbtDocCommand eq null then null else
       val cmd = if sbtDocCommand.startsWith(";") then sbtDocCommand else s";$sbtDocCommand"
-      s"$baseCommand set every useScala3doc := true; set every doc/logLevel := Level.Warn $cmd "
+      s"$baseCommand set every usescaladoc := true; set every doc/logLevel := Level.Warn $cmd "
 
   override val runCommandsArgs: List[String] =
     // Run the sbt command with the compiler version and sbt plugin set in the build

compiler/src/dotty/tools/dotc/config/ScalaSettings.scala

@@ -7,7 +7,7 @@ import PathResolver.Defaults
 import rewrites.Rewrites
 import Settings.Setting
 
-/** Settings shared by compiler and scala3doc */
+/** Settings shared by compiler and scaladoc */
 trait CommonScalaSettings { self: Settings.SettingGroup =>
   protected def defaultClasspath: String = sys.env.getOrElse("CLASSPATH", ".")
 
@@ -227,7 +227,7 @@ class ScalaSettings extends Settings.SettingGroup with CommonScalaSettings {
   val Yinstrument: Setting[Boolean] = BooleanSetting("-Yinstrument", "Add instrumentation code that counts allocations and closure creations.")
   val YinstrumentDefs: Setting[Boolean] = BooleanSetting("-Yinstrument-defs", "Add instrumentation code that counts method calls; needs -Yinstrument to be set, too.")
 
-  /** Dottydoc specific settings that are not used in scala3doc */
+  /** Dottydoc specific settings that are not used in scaladoc */
   val docSnapshot: Setting[Boolean] = BooleanSetting("-doc-snapshot", "Generate a documentation snapshot for the current Dotty version")
 
   val projectUrl: Setting[String] = StringSetting (

docs/blog/_posts/2020-12-18-scala3-m3.md

@@ -133,9 +133,9 @@ You can read the discussion of this change in the [PR #10670](https://github.com
 # Tooling improvements
 As we are getting closer to a stable release of Scala 3, the focus increasingly shifts on the tooling available to get started with Scala 3.
 
-For a while now, we are not using the old dottydoc documentation tool for building the documentation. We are developing an entirely new tool, scala3doc, from scratch. This new documentation tool is more robust and faster than the old one.
+For a while now, we are not using the old dottydoc documentation tool for building the documentation. We are developing an entirely new tool, scaladoc, from scratch. This new documentation tool is more robust and faster than the old one.
 
-As part of the tooling effort, this new Scala 3 documentation tool is rapidly improved. [PR #10522](https://github.com/lampepfl/dotty/pull/10522) proves that the doctool can generate documentation for the community build projects. You can access this documentation via the following [link](https://scala3doc.virtuslab.com/pr-master-docs/index.html).
+As part of the tooling effort, this new Scala 3 documentation tool is rapidly improved. [PR #10522](https://github.com/lampepfl/dotty/pull/10522) proves that the doctool can generate documentation for the community build projects. You can access this documentation via the following [link](https://scaladoc.virtuslab.com/pr-master-docs/index.html).
 
 [PR #10491](https://github.com/lampepfl/dotty/pull/10491) introduced scripting support in Scala 3. Consider the following source named `Main.scala`:
 

docs/docs/usage/scala3doc/blog.md → docs/docs/usage/scaladoc/blog.md

@@ -4,6 +4,6 @@ title: Built-in blog
 
 # {{page.title}}
 
-Scala3doc allows you to include a simple blog in your documentation. For now, it
+scaladoc allows you to include a simple blog in your documentation. For now, it
 provides only basic features. In the future, we plan to include more advanced
 features like tagging or author pages.

docs/docs/usage/scala3doc/docComments.md → docs/docs/usage/scaladoc/docComments.md

@@ -4,7 +4,7 @@ title: API Documentation
 
 # {{ page.title }}
 
-Scala3doc's main feature is creating API documentation from code comments.
+scaladoc's main feature is creating API documentation from code comments.
 
 By default, the code comments are understood as Markdown, though we also support
 Scaladoc's old [Wiki syntax](https://docs.scala-lang.org/style/scaladoc.html).
@@ -75,7 +75,7 @@ closer together. The new features are:
     def foo = `([.abusive.])`
     ```
     Scaladoc required backslash-escaping to reference such identifiers. Instead,
-    Scala3doc allows using the familiar Scala backtick quotation.
+    scaladoc allows using the familiar Scala backtick quotation.
 
 #### Why keep the Wiki syntax for links?
 

docs/docs/usage/scala3doc/index.md → docs/docs/usage/scaladoc/index.md

@@ -1,12 +1,12 @@
 ---
-title: Scala3doc
+title: scaladoc
 ---
 
-![Scala3doc logo](/images/scala3doc-logo.png)
+![scaladoc logo](/images/scaladoc-logo.png)
 
-Scala3doc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc` or `scaladoc` as well as `jekyll` or `docusaurus`.
+scaladoc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc` or `scaladoc` as well as `jekyll` or `docusaurus`.
 
-As you probably have guessed, this whole site was created using Scala3doc.
+As you probably have guessed, this whole site was created using scaladoc.
 
 
 {% for post in site.posts %}

docs/docs/usage/scala3doc/specificTags.md → docs/docs/usage/scaladoc/specificTags.md

@@ -1,15 +1,15 @@
 ---
-title: Scala3doc-specific Tags and Features
+title: scaladoc-specific Tags and Features
 ---
 
 # {{page.title}}
 
-Scala3doc extends Markdown with additional features, such as linking
+scaladoc extends Markdown with additional features, such as linking
 to API definitions. This can be used from within static documentation and blog
 posts to provide blend-in content.
 
 ## Linking to API
 
-Scala3doc allows linking to API documentation with Wiki-style links. Linking to
+scaladoc allows linking to API documentation with Wiki-style links. Linking to
 `scala.collection.immutable.List` is as simple as
 `[[scala.collection.immutable.List]]`. For more information on the exact syntax, see [doc comment documentation](./docComments.html#definition-links).

docs/docs/usage/scala3doc/staticSite.md → docs/docs/usage/scaladoc/staticSite.md

@@ -4,7 +4,7 @@ title: Static documentation
 
 # {{ page.title}}
 
-Scala3doc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
+scaladoc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
 Having a combined tool allows to provide interaction between static documentation and API, thus allowing the two to blend naturally.
 
 Creating a site is just as simple as in Jekyll. The site root contains the
@@ -29,18 +29,18 @@ index.html
 docs/getting-started.html
 ```
 
-Scala3doc can transform both files and directories (to organize your documentation into tree-like structure). By default directories has title based on file name and has empty content. There is an option to include `index.html` or `index.md` (not both) to provide both content and properties like title (see [Properties](#properties)).
+scaladoc can transform both files and directories (to organize your documentation into tree-like structure). By default directories has title based on file name and has empty content. There is an option to include `index.html` or `index.md` (not both) to provide both content and properties like title (see [Properties](#properties)).
 
 ## Properties
 
-Scala3doc uses the [Liquid](https://shopify.github.io/liquid/) templating engine
+scaladoc uses the [Liquid](https://shopify.github.io/liquid/) templating engine
 and provides a number of custom filters and tags specific to Scala
 documentation.
 
-In Scala3doc, all templates can contain YAML front-matter. The front-matter
+In scaladoc, all templates can contain YAML front-matter. The front-matter
 is parsed and put into the `page` variable available in templates via Liquid.
 
-Scala3doc uses some predefined properties to controls some aspect of page.
+scaladoc uses some predefined properties to controls some aspect of page.
 
 Predefined properties:
 
@@ -94,7 +94,7 @@ Layouts must be placed in a `_layouts` directory in the site root:
 
 Sidebar
 =======
-Scala3doc by default uses layout of files in `docs` directory to create table of content. There is also ability to override it by providing a `sidebar.yml` file in the site root:
+scaladoc by default uses layout of files in `docs` directory to create table of content. There is also ability to override it by providing a `sidebar.yml` file in the site root:
 
 ```yaml
 sidebar:

docs/sidebar.yml

@@ -15,8 +15,8 @@ sidebar:
           url: docs/usage/language-versions.html
         - title: cbt-projects
           url: docs/usage/cbt-projects.html
-        - title: Scala3doc
-          url: docs/usage/scala3doc
+        - title: scaladoc
+          url: docs/usage/scaladoc
         - title: Dottydoc [Legacy]
           url: docs/usage/dottydoc.html
     - title: Reference