Strona główna Odkrywaj Pomoc
Zaloguj się
carto
/
grpc
2
0
Forkuj 0
Pliki Problemy 0 Oczekujące zmiany 0 Wiki
Drzewo: f0cb7e6bdc
Gałęzie Tagi
grpc
/
src
/
csharp
/
doc
kkm 27771aa604 Document .NET build integration with Grpc.Tools 7 lat temu
..
.gitignore 9c437c2067 Use docfx to generate C# API reference 8 lat temu
README.md 082ee89641 add script for automatic generation of C# reference docs 7 lat temu
docfx.json 89642bb205 Corrected formatting of json files 7 lat temu
generate_reference_docs.sh 082ee89641 add script for automatic generation of C# reference docs 7 lat temu
integration.md-fig.1-classic.png 27771aa604 Document .NET build integration with Grpc.Tools 7 lat temu
integration.md-fig.2-sdk.png 27771aa604 Document .NET build integration with Grpc.Tools 7 lat temu
toc.yml 9c437c2067 Use docfx to generate C# API reference 8 lat temu

README.md

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