aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/csharp/doc/generate_reference_docs.sh
blob: c20d6c30bd3248438e8a61f62611dd7475186379 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#!/bin/sh
# Copyright 2018 The gRPC Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Generates C# API docs using docfx inside docker.
set -ex
cd $(dirname $0)

# cleanup temporary files
rm -rf html obj grpc-gh-pages

# generate into src/csharp/doc/html directory
cd ..
docker run --rm -v "$(pwd)":/work -w /work/doc --user "$(id -u):$(id -g)" -it tsgkadot/docker-docfx:latest docfx
cd doc

# prepare a clone of "gh-pages" branch where the generated docs are stored
GITHUB_USER="${USER}"
git clone -b gh-pages -o upstream git@github.com:grpc/grpc.git grpc-gh-pages
cd grpc-gh-pages
git remote add origin "git@github.com:${GITHUB_USER}/grpc.git"

# replace old generated docs by the ones we just generated
rm -r csharp
cp -r ../html csharp

echo "Done. Go to src/csharp/doc/grpc-gh-pages git repository and create a pull request to update the generated docs."