Skip to content

Commit 32ef270

Browse files
pekkaklarckaaltat
pekkaklarck
authored and
aaltat
committed
Project docs (robotframework#947)
* Generate project documentation based on README. This docs are shown at http://robotframework.org/SeleniumLibrary/. style.css is from https://bitbucket.org/cskeeters/rst2html-style/. Licensed under the MIT license. For consistency, renamed related keyword-documentation invoke task to kw-docs. Regenerated project docs
1 parent 7032236 commit 32ef270

6 files changed

Lines changed: 1219 additions & 21 deletions

File tree

‎BUILD.rst‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -149,19 +149,22 @@ Set version
149149
git commit -m "Updated version to $VERSION" src/SeleniumLibrary/__init__.py
150150
git push
151151

152-
Keyword documentation
153-
---------------------
152+
Documentation
153+
-------------
154154

155155
1. Generate keyword documentation::
156156

157-
invoke keyword-documentation
157+
invoke kw-docs
158+
git commit -m "Generated docs for version $VERSION" docs/SeleniumLibrary.html
159+
git push
158160

159161
Note that this *must* be done after`setting version <Set version>`_ above
160162
or docs will have wrong version number.
161163

162-
2. Commit and push changes::
164+
2. If README.rst has changed, generate project documentation based on it::
163165

164-
git commit -m "Generated docs for version $VERSION" docs/SeleniumLibrary.html
166+
invoke project-docs
167+
git commit -m "Regenerated project docs" docs/index.html
165168
git push
166169

167170
Tagging

‎docs/extra.css‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/* Additional styles to use with style.css. */
2+
3+
#contents p, table p {
4+
margin: 0;
5+
}
6+
th, td {
7+
padding: 0.2em 0.4em;
8+
border-width: 1px;
9+
border-style: solid;
10+
vertical-align: top;
11+
}
12+
th {
13+
white-space: nowrap;
14+
vertical-align: middle;
15+
}

0 commit comments

Comments
 (0)