Skip to content

Commit 1d3e4f1

Browse files
grzegorz-bielskiromanowski
authored andcommitted
Use project scoped cmds in the README
1 parent 1c7da87 commit 1d3e4f1

File tree

1 file changed

+17
-23
lines changed

1 file changed

+17
-23
lines changed

scala3doc/README.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,11 @@ We're aiming to support all the features Scaladoc did, plus new and exciting one
1717

1818
## Running the project
1919

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:
2121

2222
```
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
3225
```
3326

3427
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.
4841
## CLI Documentation
4942

5043
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:
58-
- [GitHub](https://github.com/VirtusLab/dokka-site)
59-
- [Documentation](https://virtuslab.github.io/dokka-site/index.html)
44+
45+
- `<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:
52+
- [GitHub](https://github.com/VirtusLab/dokka-site)
53+
- [Documentation](https://virtuslab.github.io/dokka-site/index.html)
6054

6155
## Developing
6256

@@ -66,16 +60,16 @@ work on the project.
6660
For every PR, we build documentation for Scala3doc and Dotty. For example, for
6761
PR 123 you can find them at:
6862

69-
+ <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-123/self/main/index.html>
70-
+ <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-123/stdLib/main/index.html>
63+
- <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-123/self/main/index.html>
64+
- <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-123/stdLib/main/index.html>
7165

7266
Note that these correspond to the contents of `output` directory - that's
7367
precisely what they are.
7468

7569
You can also find the result of building the same sites for latest `master` at:
7670

77-
+ <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-master/self/main/index.html>
78-
+ <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-master/stdLib/main/index.html>
71+
- <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-master/self/main/index.html>
72+
- <https://scala3doc.s3.eu-central-1.amazonaws.com/pr-master/stdLib/main/index.html>
7973

8074
### Testing
8175

0 commit comments

Comments
 (0)