Skip to content

Commit 6b49a41

Browse files
committed
Merge pull request scala#421 from felixmulder/topic/blog-getting-into-scaladoc-fix
Fix formatting on "Getting into Scaladoc" blogpost
2 parents 757b32b + 4cd1380 commit 6b49a41

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

blog/_posts/2016-03-17-getting-into-scaladoc-dev.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,8 @@ Have a look there for a more complete overview.
6060

6161
Simple:
6262

63-
```bash
64-
$ git clone [email protected]:scala/scala.git && cd scala
65-
$ ant docs # "ant docs.lib" if you just want the standard library
66-
```
63+
$ git clone [email protected]:scala/scala.git && cd scala
64+
$ ant docs # "ant docs.lib" if you just want the standard library
6765

6866
## Where to begin ##
6967

@@ -82,32 +80,24 @@ That's where you'd want to put new things (it is also where `index.js` etc live!
8280
**How can I see my changes?** You have two options, if you changed the markup -
8381
you'll need to regenerate the docs:
8482

85-
```bash
86-
$ ant docs.clean && ant docs
87-
```
83+
$ ant docs.clean && ant docs
8884

8985
When the changes are to scripts or style sheets I use a small `Makefile` in the
9086
root of the project. This makefile will simply copy the resources to the same location
9187
as the generated docs:
9288

93-
```make
94-
all:
95-
cp src/scaladoc/scala/tools/nsc/doc/html/resource/lib/{index.css,index.js,template.css,template.js,diagrams.css,diagrams.js} build/scaladoc/library/lib/
96-
```
89+
all:
90+
cp src/scaladoc/scala/tools/nsc/doc/html/resource/lib/{index.css,index.js,template.css,template.js,diagrams.css,diagrams.js} build/scaladoc/library/lib/
9791

9892
Regenerating the docs all the time is a pain - if you just want to generate
9993
them for a single file, do this:
10094

101-
```bash
102-
$ ant quick.bin
103-
$ build/quick/bin/scaladoc path/to/source/File.scala
104-
```
95+
$ ant quick.bin
96+
$ build/quick/bin/scaladoc path/to/source/File.scala
10597

10698
Lastly, before you open your pull request - test your changes!
10799

108-
```bash
109-
$ ant test.scaladoc
110-
```
100+
$ ant test.scaladoc
111101

112102
## Where to really begin ##
113103

0 commit comments

Comments
 (0)