8000 NR add extra step · mongodb/docs-java-other@3c735c8 · GitHub
[go: up one dir, main page]

Skip to content

Commit 3c735c8

Browse files
committed
NR add extra step
1 parent f86fbb2 commit 3c735c8

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,22 @@ git checkout r4.4.0
3636
./gradlew clean docs
3737
```
3838

39+
You need to create the `<version>/apidocs` directory yourself before
40+
copying the generated API docs files.
41+
42+
Run the following commands to create the `apidocs` directory:
43+
44+
````sh
45+
cd docs-java-other/mongo-java-driver
46+
mkdir -p <version>/apidocs
47+
```
48+
3949
Then copy the `build/docs` folder into the `apidocs` directory. For example,
4050
if the `mongo-java-driver` repo is on a sibling level with this repo, run the following command:
4151

4252
```sh
4353
cp -a ../mongo-java-driver/build/docs ./mongo-java-driver/<version>/apidocs
44-
```
54+
````
4555
4656
Your submodule directory should contain a directory structure that resembles the following:
4757
@@ -53,7 +63,7 @@ Your submodule directory should contain a directory structure that resembles the
5363
5464
To publish the documentation, run the following commands in your shell from the `docs-java-other` repository location:
5565
56-
```js
66+
```sh
5767
cd mongo-java-driver
5868
git add .
5969
git commit -m <message>

0 commit comments

Comments
 (0)
0