Skip to content

Commit 792cf55

Browse files
committed
Modify Generating Documentation section to use updated instructions for doc generation
1 parent f618dd6 commit 792cf55

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/docs/contributing/getting-started.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,22 @@ Generating Documentation
8383
-------------------------
8484
To generate this page and other static page docs, run
8585
```bash
86+
# the generated docs will be located in scaladoc/output
8687
$ sbt
87-
> genDocs
88+
> scalaDoc/generateScalaDocumentation
89+
90+
# or run the following bash script to generate docs under $PWD/docs/_site
91+
$ ./project/scripts/genDocs
8892
```
93+
See `scaladoc/README.md` for more information on developing with the docs.
94+
95+
To generate docs for a specific module (e.g. `scala3-compiler-bootstrapped`), run
96+
```bash
97+
$ sbt
98+
> scala3-compiler-bootstrapped/doc
99+
```
100+
101+
89102

90103
Before contributing to Dotty, we invite you to consult the
91104
[Dotty Developer Guidelines](https://github.com/lampepfl/dotty/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)