You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: scala3doc/README.md
+17-23Lines changed: 17 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -17,18 +17,11 @@ We're aiming to support all the features Scaladoc did, plus new and exciting one
17
17
18
18
## Running the project
19
19
20
-
Run `sbt` and switch to scala3doc project from the root
20
+
Use the following commands to generate documentation for this project and for Dotty, respectively:
21
21
22
22
```
23
-
sbt
24
-
project scala3doc
25
-
```
26
-
27
-
When in the `scala3doc` project in `sbt`, use the following commands to generate documentation for this project and for Dotty, respectively:
28
-
29
-
```
30
-
generateSelfDocumentation
31
-
generateScala3Documentation
23
+
sbt scala3doc/generateSelfDocumentation
24
+
sbt scala3doc/generateScala3Documentation
32
25
```
33
26
34
27
To actually view the documentation, the easiest way is to run the following in project root:
@@ -48,15 +41,16 @@ the documentation won't work completely if you don't.
48
41
## CLI Documentation
49
42
50
43
CLI command for running our tool is in form: `sbt main -n <name> -o <output> -t <tasty-files> -cp <classpath> -s { <sources> } -d <documentation> ` where:
51
-
-`<name>`: name of module in generated documentation
52
-
-`<output>`: location where documentation should be created
53
-
-`<tasty-files>`: is list of dirs or jars that contains tasty files that should be documented
54
-
-`<classpath>`: classpath that was used to generate tasty files
55
-
-`<sources>`: links to source files of module that are used to link symbols on pages to their source file. They need to be supplied in form:
56
-
`local_dir=remote_dir#line_suffix` e.g. `src/main/scala=https://github.com/lampepfl/scala3doc/tree/master/src/main/scala#L`
57
-
-`<documentation>`: directory of static documentation that you would like to render with API documentation. This feature is provided by dokka-site plugin:
-`<name>`: name of module in generated documentation
46
+
-`<output>`: location where documentation should be created
47
+
-`<tasty-files>`: is list of dirs or jars that contains tasty files that should be documented
48
+
-`<classpath>`: classpath that was used to generate tasty files
49
+
-`<sources>`: links to source files of module that are used to link symbols on pages to their source file. They need to be supplied in form:
50
+
`local_dir=remote_dir#line_suffix` e.g. `src/main/scala=https://github.com/lampepfl/scala3doc/tree/master/src/main/scala#L`
51
+
-`<documentation>`: directory of static documentation that you would like to render with API documentation. This feature is provided by dokka-site plugin:
0 commit comments