• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1DocFX-generated C# API Reference
2--------------------------------
3
4## Generating docs manually (on Windows)
5
6Install docfx based on instructions here: https://github.com/dotnet/docfx
7
8```
9# generate docfx documentation into ./html directory
10$ docfx
11```
12
13## Release process: script for regenerating the docs automatically
14
15After each gRPC C# release, the docs need to be regenerated
16and updated on the grpc.io site. The automated script will
17re-generate the docs (using dockerized docfx installation)
18and make everything ready for creating a PR to update the docs.
19
20```
21# 1. Run the script on Linux with docker installed
22$ ./generate_reference_docs.sh
23
24# 2. Enter the git repo with updated "gh-pages" branch
25$ cd grpc-gh-pages
26
27# 3. Review the changes and create a pull request
28```
29