carto/grpc @ backport_25456_to_v1.35.x

Jan Tattermusch acd040e571 fix C# docfx script		6 年之前
..
.gitignore	e466546743 make reference docs tooling to docfx directory to avoid collision	6 年之前
README.md	e466546743 make reference docs tooling to docfx directory to avoid collision	6 年之前
docfx.json	e466546743 make reference docs tooling to docfx directory to avoid collision	6 年之前
generate_reference_docs.sh	acd040e571 fix C# docfx script	6 年之前
toc.yml	e466546743 make reference docs tooling to docfx directory to avoid collision	6 年之前

DocFX-generated C# API Reference

Generating docs manually (on Windows)

Install docfx based on instructions here: https://github.com/dotnet/docfx

# generate docfx documentation into ./html directory
$ docfx

Release process: script for regenerating the docs automatically

After each gRPC C# release, the docs need to be regenerated and updated on the grpc.io site. The automated script will re-generate the docs (using dockerized docfx installation) and make everything ready for creating a PR to update the docs.

# 1. Run the script on Linux with docker installed
$ ./generate_reference_docs.sh

# 2. Enter the git repo with updated "gh-pages" branch
$ cd grpc-gh-pages

# 3. Review the changes and create a pull request

README.md

DocFX-generated C# API Reference

Generating docs manually (on Windows)

Release process: script for regenerating the docs automatically