Skip to content

Commit d65e38e

Browse files
committed
[rb] Fix documentation generator
1 parent aefde12 commit d65e38e

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ This article is out of date, but it includes more detailed descriptions and scre
5353
<summary>Click to see Current Windows Setup Requirements</summary>
5454

5555
#### Option 1: Automatic Installation from Scratch
56-
This script will ensure a complete ready to execute developer environment.
57-
(nothing is installed or set that is already present unless otherwise prompted)
56+
This script will ensure a complete ready to execute developer environment.
57+
(nothing is installed or set that is already present unless otherwise prompted)
5858

5959
1. Open Powershell as an Administrator
6060
2. Execute: `Set-ExecutionPolicy Bypass -Scope Process -Force` to allow running the script in the process
61-
3. Navigate to the directory you want to clone Selenium in, or the parent directory of an already cloned Selenium repo
61+
3. Navigate to the directory you want to clone Selenium in, or the parent directory of an already cloned Selenium repo
6262
4. Download and execute this script in the powershell terminal: [scripts/dev-environment-setup.ps1]`
6363

6464
#### Option 2: Manual Installation
@@ -110,7 +110,7 @@ for building and testing Selenium using the Dockerfile in the
110110
111111
## Building
112112
113-
Selenium is built using a common build tool called [Bazel](https://bazel.build/), to
113+
Selenium is built using a common build tool called [Bazel](https://bazel.build/), to
114114
allow us to easily manage dependency downloads, generate required binaries, build and release packages, and execute tests;
115115
all in a fast, efficient manner. For a more detailed discussion, read Simon Stewart's article on [Building Selenium](https://www.selenium.dev/blog/2023/building-selenium/)
116116
@@ -119,12 +119,12 @@ Often we wrap Bazel commands with our custom [Rake](http://rake.rubyforge.org/)
119119
The common Bazel commands are:
120120
* `bazel build` — evaluates dependencies, compiles source files and generates output files for the specified target.
121121
It's used to create executable binaries, libraries, or other artifacts.
122-
* `bazel run` — builds the target and then executes it.
122+
* `bazel run` — builds the target and then executes it.
123123
It's typically used for targets that produce executable binaries.
124124
* `bazel test` — builds and runs the target in a context with additional testing functionality
125125
* `bazel query` — identifies available targets for the provided path.
126126
127-
Each module that can be built is defined in a `BUILD.bazel` file. To execute the module you refer to it starting with a
127+
Each module that can be built is defined in a `BUILD.bazel` file. To execute the module you refer to it starting with a
128128
`//`, then include the relative path to the file that defines it, then `:`, then the name of the target.
129129
For example, the target to build the Grid is named `executable-grid` and it is
130130
defined in the `'selenium/java/src/org/openqa/selenium/grid/BAZEL.build'` file.
@@ -164,7 +164,7 @@ view file from the [scripts](scripts) directory. `ij.bazelproject` for Mac/Linux
164164

165165
#### Linting
166166
We also use Google Java Format for linting, so using the Google Java Formatter Plugin is useful;
167-
there are a few steps to get it working, so read their [configuration documentation](https://github.com/google/google-java-format/blob/master/README.md#intellij-jre-config).
167+
there are a few steps to get it working, so read their [configuration documentation](https://github.com/google/google-java-format/blob/master/README.md#intellij-jre-config).
168168
There is also an auto-formatting script that can be run: `./scripts/format.sh`
169169

170170
#### Local Installation
@@ -208,7 +208,7 @@ If you want to debug code, you can do it via [`debug`](https://github.com/ruby/d
208208
bazel-selenium/external/bundle/bin/rdbg -A
209209
```
210210

211-
If you want to use [RubyMine](https://www.jetbrains.com/ruby/) for development,
211+
If you want to use [RubyMine](https://www.jetbrains.com/ruby/) for development,
212212
you can configure it use Bazel artifacts:
213213

214214
1. Open `rb/` as a main project directory.
@@ -451,9 +451,9 @@ API documentation can be found here:
451451
* [Python](https://seleniumhq.github.io/selenium/docs/api/py/)
452452
* [Ruby](https://seleniumhq.github.io/selenium/docs/api/rb/)
453453

454-
To update API documentation for a specific language: `./generate_api_docs.sh <language>`
454+
To update API documentation for a specific language: `./go <language>:docs`
455455

456-
To update all documentation: `./generate_api_docs.sh all`
456+
To update all documentation: `./go all:docs`
457457

458458
Note that JavaScript generation is [currently broken](https://github.com/SeleniumHQ/selenium/issues/10185).
459459

@@ -463,7 +463,7 @@ Note that JavaScript generation is [currently broken](https://github.com/Seleniu
463463
The full process for doing a release can be found in [the wiki](https://github.com/SeleniumHQ/selenium/wiki/Releasing-Selenium)
464464

465465
Releasing is a combination of building and publishing, which often requires coordination of multiple executions
466-
and additional processing.
466+
and additional processing.
467467
As discussed in the [Building](#building) section, we use Rake tasks with the `./go` command for these things.
468468
These `./go` commands include the `--stamp` argument to provide necessary information about the constructed asset.
469469

Rakefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,7 @@ namespace :rb do
711711
task :docs, [:skip_update] do |_task, arguments|
712712
FileUtils.rm_rf('build/docs/api/rb/')
713713
Bazel.execute('run', [], '//rb:docs')
714+
FileUtils.mkdir_p('build/docs/api')
714715
FileUtils.cp_r('bazel-bin/rb/docs.rb.sh.runfiles/selenium/docs/api/rb/.', 'build/docs/api/rb')
715716

716717
unless arguments[:skip_update]

0 commit comments

Comments
 (0)