@@ -60,10 +60,8 @@ Have a look there for a more complete overview.
60
60
61
61
Simple:
62
62
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
67
65
68
66
## Where to begin ##
69
67
@@ -82,32 +80,24 @@ That's where you'd want to put new things (it is also where `index.js` etc live!
82
80
** How can I see my changes?** You have two options, if you changed the markup -
83
81
you'll need to regenerate the docs:
84
82
85
- ``` bash
86
- $ ant docs.clean && ant docs
87
- ```
83
+ $ ant docs.clean && ant docs
88
84
89
85
When the changes are to scripts or style sheets I use a small ` Makefile ` in the
90
86
root of the project. This makefile will simply copy the resources to the same location
91
87
as the generated docs:
92
88
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/
97
91
98
92
Regenerating the docs all the time is a pain - if you just want to generate
99
93
them for a single file, do this:
100
94
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
105
97
106
98
Lastly, before you open your pull request - test your changes!
107
99
108
- ``` bash
109
- $ ant test.scaladoc
110
- ```
100
+ $ ant test.scaladoc
111
101
112
102
## Where to really begin ##
113
103
0 commit comments