Skip to content

Commit ed17258

Browse files
committed
rename scala3doc into scaladoc
1 parent b640691 commit ed17258

File tree

285 files changed

+189
-189
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

285 files changed

+189
-189
lines changed

.github/workflows/scala3doc.yaml renamed to .github/workflows/scaladoc.yaml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Scala3doc
1+
name: scaladoc
22

33
on:
44
push:
@@ -12,7 +12,7 @@ jobs:
1212
&& !contains(github.event.pull_request.body, '[skip ci]')
1313
&& !contains(github.event.pull_request.body, '[skip docs]')
1414
)
15-
|| contains(github.event.ref, 'scala3doc')
15+
|| contains(github.event.ref, 'scaladoc')
1616
|| contains(github.event.ref, 'master')"
1717

1818
steps:
@@ -36,25 +36,25 @@ jobs:
3636
java-version: 11
3737

3838
- name: Compile and test
39-
run: ./project/scripts/sbt scala3doc/test
39+
run: ./project/scripts/sbt scaladoc/test
4040

4141
- name: Locally publish self
42-
run: ./project/scripts/sbt scala3doc/publishLocal
42+
run: ./project/scripts/sbt scaladoc/publishLocal
4343

4444
- name: Generate self documentation
45-
run: ./project/scripts/sbt scala3doc/generateSelfDocumentation
45+
run: ./project/scripts/sbt scaladoc/generateSelfDocumentation
4646

4747
- name: Generate testcases documentation
48-
run: ./project/scripts/sbt scala3doc/generateTestcasesDocumentation
48+
run: ./project/scripts/sbt scaladoc/generateTestcasesDocumentation
4949

5050
- name: Generate Scala 3 documentation
51-
run: ./project/scripts/sbt scala3doc/generateScala3Documentation
51+
run: ./project/scripts/sbt scaladoc/generatescaladocumentation
5252

5353
- name: Generate documentation for example project using dotty-sbt
54-
run: ./project/scripts/sbt "sbt-dotty/scripted sbt-dotty/scala3doc"
54+
run: ./project/scripts/sbt "sbt-dotty/scripted sbt-dotty/scaladoc"
5555

5656
- name: Generate index file
57-
run: scala3doc/scripts/mk-index.sh scala3doc/output > scala3doc/output/index.html
57+
run: scaladoc/scripts/mk-index.sh scaladoc/output > scaladoc/output/index.html
5858

5959
- name: Upload documentation to server
6060
uses: azure/CLI@v1
@@ -64,9 +64,9 @@ jobs:
6464
with:
6565
inlineScript: |
6666
DOC_DEST=pr-${PR_NUMBER:-${GITHUB_REF##*/}}
67-
echo uplading docs to https://scala3doc.virtuslab.com/$DOC_DEST
68-
az storage container create --name $DOC_DEST --account-name scala3docstorage --public-access container
69-
az storage blob sync -s scala3doc/output -c $DOC_DEST --account-name scala3docstorage
67+
echo uplading docs to https://scaladoc.virtuslab.com/$DOC_DEST
68+
az storage container create --name $DOC_DEST --account-name scaladocstorage --public-access container
69+
az storage blob sync -s scaladoc/output -c $DOC_DEST --account-name scaladocstorage
7070
7171
community-docs:
7272
env:
@@ -76,7 +76,7 @@ jobs:
7676
&& !contains(github.event.pull_request.body, '[skip ci]')
7777
&& !contains(github.event.pull_request.body, '[skip docs]')
7878
)
79-
|| contains(github.event.ref, 'scala3doc')
79+
|| contains(github.event.ref, 'scaladoc')
8080
|| contains(github.event.ref, 'master')"
8181

8282
steps:
@@ -102,6 +102,6 @@ jobs:
102102
with:
103103
inlineScript: |
104104
DOC_DEST=pr-${PR_NUMBER:-${GITHUB_REF##*/}}-docs
105-
echo uplading docs to https://scala3doc.virtuslab.com/$DOC_DEST
106-
az storage container create --name $DOC_DEST --account-name scala3docstorage --public-access container
107-
az storage blob sync -s community-build/docsOutput -c $DOC_DEST --account-name scala3docstorage
105+
echo uplading docs to https://scaladoc.virtuslab.com/$DOC_DEST
106+
az storage container create --name $DOC_DEST --account-name scaladocstorage --public-access container
107+
az storage blob sync -s community-build/docsOutput -c $DOC_DEST --account-name scaladocstorage

build.sbt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ val `stdlib-bootstrapped-tasty-tests` = Build.`stdlib-bootstrapped-tasty-tests`
2020
val `tasty-core` = Build.`tasty-core`
2121
val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped`
2222
val `tasty-core-scala2` = Build.`tasty-core-scala2`
23-
val scala3doc = Build.scala3doc
24-
val `scala3doc-testcases` = Build.`scala3doc-testcases`
25-
val `scala3doc-js` = Build.`scala3doc-js`
23+
val scaladoc = Build.scaladoc
24+
val `scaladoc-testcases` = Build.`scaladoc-testcases`
25+
val `scaladoc-js` = Build.`scaladoc-js`
2626
val `scala3-bench-run` = Build.`scala3-bench-run`
2727
val dist = Build.dist
2828
val `community-build` = Build.`community-build`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ object Main:
1212
val name = project.project
1313
try
1414
project.doc()
15-
val pathsOut = s"find community-projects/$name/ -name 'scala3doc.version'".!!
15+
val pathsOut = s"find community-projects/$name/ -name 'scaladoc.version'".!!
1616
pathsOut.linesIterator.map(Paths.get(_).getParent).toList
1717
catch
1818
case e: Exception =>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,12 +162,12 @@ final case class SbtCommunityProject(
162162

163163
override val publishCommand = if sbtPublishCommand eq null then null else
164164
val disableDocCommand =
165-
if sbtDocCommand eq null then "" else "set every useScala3doc := false;"
165+
if sbtDocCommand eq null then "" else "set every usescaladoc := false;"
166166
s"$baseCommand$disableDocCommand$sbtPublishCommand"
167167
override val docCommand =
168168
if sbtDocCommand eq null then null else
169169
val cmd = if sbtDocCommand.startsWith(";") then sbtDocCommand else s";$sbtDocCommand"
170-
s"$baseCommand set every useScala3doc := true; set every doc/logLevel := Level.Warn $cmd "
170+
s"$baseCommand set every usescaladoc := true; set every doc/logLevel := Level.Warn $cmd "
171171

172172
override val runCommandsArgs: List[String] =
173173
// Run the sbt command with the compiler version and sbt plugin set in the build

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import PathResolver.Defaults
77
import rewrites.Rewrites
88
import Settings.Setting
99

10-
/** Settings shared by compiler and scala3doc */
10+
/** Settings shared by compiler and scaladoc */
1111
trait CommonScalaSettings { self: Settings.SettingGroup =>
1212
protected def defaultClasspath: String = sys.env.getOrElse("CLASSPATH", ".")
1313

@@ -227,7 +227,7 @@ class ScalaSettings extends Settings.SettingGroup with CommonScalaSettings {
227227
val Yinstrument: Setting[Boolean] = BooleanSetting("-Yinstrument", "Add instrumentation code that counts allocations and closure creations.")
228228
val YinstrumentDefs: Setting[Boolean] = BooleanSetting("-Yinstrument-defs", "Add instrumentation code that counts method calls; needs -Yinstrument to be set, too.")
229229

230-
/** Dottydoc specific settings that are not used in scala3doc */
230+
/** Dottydoc specific settings that are not used in scaladoc */
231231
val docSnapshot: Setting[Boolean] = BooleanSetting("-doc-snapshot", "Generate a documentation snapshot for the current Dotty version")
232232

233233
val projectUrl: Setting[String] = StringSetting (

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@ You can read the discussion of this change in the [PR #10670](https://github.com
133133
# Tooling improvements
134134
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.
135135

136-
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.
136+
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.
137137

138-
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).
138+
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).
139139

140140
[PR #10491](https://github.com/lampepfl/dotty/pull/10491) introduced scripting support in Scala 3. Consider the following source named `Main.scala`:
141141

docs/docs/usage/scala3doc/blog.md renamed to docs/docs/usage/scaladoc/blog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ title: Built-in blog
44

55
# {{page.title}}
66

7-
Scala3doc allows you to include a simple blog in your documentation. For now, it
7+
scaladoc allows you to include a simple blog in your documentation. For now, it
88
provides only basic features. In the future, we plan to include more advanced
99
features like tagging or author pages.

docs/docs/usage/scala3doc/docComments.md renamed to docs/docs/usage/scaladoc/docComments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: API Documentation
44

55
# {{ page.title }}
66

7-
Scala3doc's main feature is creating API documentation from code comments.
7+
scaladoc's main feature is creating API documentation from code comments.
88

99
By default, the code comments are understood as Markdown, though we also support
1010
Scaladoc's old [Wiki syntax](https://docs.scala-lang.org/style/scaladoc.html).
@@ -75,7 +75,7 @@ closer together. The new features are:
7575
def foo = `([.abusive.])`
7676
```
7777
Scaladoc required backslash-escaping to reference such identifiers. Instead,
78-
Scala3doc allows using the familiar Scala backtick quotation.
78+
scaladoc allows using the familiar Scala backtick quotation.
7979
8080
#### Why keep the Wiki syntax for links?
8181

docs/docs/usage/scala3doc/index.md renamed to docs/docs/usage/scaladoc/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Scala3doc
2+
title: scaladoc
33
---
44

5-
![Scala3doc logo](/images/scala3doc-logo.png)
5+
![scaladoc logo](/images/scaladoc-logo.png)
66

7-
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`.
7+
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`.
88

9-
As you probably have guessed, this whole site was created using Scala3doc.
9+
As you probably have guessed, this whole site was created using scaladoc.
1010

1111

1212
{% for post in site.posts %}
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Scala3doc-specific Tags and Features
2+
title: scaladoc-specific Tags and Features
33
---
44

55
# {{page.title}}
66

7-
Scala3doc extends Markdown with additional features, such as linking
7+
scaladoc extends Markdown with additional features, such as linking
88
to API definitions. This can be used from within static documentation and blog
99
posts to provide blend-in content.
1010

1111
## Linking to API
1212

13-
Scala3doc allows linking to API documentation with Wiki-style links. Linking to
13+
scaladoc allows linking to API documentation with Wiki-style links. Linking to
1414
`scala.collection.immutable.List` is as simple as
1515
`[[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 renamed to docs/docs/usage/scaladoc/staticSite.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Static documentation
44

55
# {{ page.title}}
66

7-
Scala3doc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
7+
scaladoc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
88
Having a combined tool allows to provide interaction between static documentation and API, thus allowing the two to blend naturally.
99

1010
Creating a site is just as simple as in Jekyll. The site root contains the
@@ -29,18 +29,18 @@ index.html
2929
docs/getting-started.html
3030
```
3131

32-
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)).
32+
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)).
3333

3434
## Properties
3535

36-
Scala3doc uses the [Liquid](https://shopify.github.io/liquid/) templating engine
36+
scaladoc uses the [Liquid](https://shopify.github.io/liquid/) templating engine
3737
and provides a number of custom filters and tags specific to Scala
3838
documentation.
3939

40-
In Scala3doc, all templates can contain YAML front-matter. The front-matter
40+
In scaladoc, all templates can contain YAML front-matter. The front-matter
4141
is parsed and put into the `page` variable available in templates via Liquid.
4242

43-
Scala3doc uses some predefined properties to controls some aspect of page.
43+
scaladoc uses some predefined properties to controls some aspect of page.
4444

4545
Predefined properties:
4646

@@ -94,7 +94,7 @@ Layouts must be placed in a `_layouts` directory in the site root:
9494

9595
Sidebar
9696
=======
97-
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:
97+
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:
9898

9999
```yaml
100100
sidebar:
File renamed without changes.

docs/sidebar.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ sidebar:
1515
url: docs/usage/language-versions.html
1616
- title: cbt-projects
1717
url: docs/usage/cbt-projects.html
18-
- title: Scala3doc
19-
url: docs/usage/scala3doc
18+
- title: scaladoc
19+
url: docs/usage/scaladoc
2020
- title: Dottydoc [Legacy]
2121
url: docs/usage/dottydoc.html
2222
- title: Reference

0 commit comments

Comments
 (0)