13 Commits

Author SHA1 Message Date
gRPC Team Bot
8679637161 Internal change
PiperOrigin-RevId: 858231029
2026-01-19 18:27:40 +00:00
Craig Tiller
f931c4a5e7 Revert "[Python] Modernize and revamp Public API Docs (#41287)" (#41443)
This reverts commit 977dd13944.

Temporary revert to help fix internal tooling
2026-01-19 10:09:11 -08:00
Sreenithi Sridharan
977dd13944 [Python] Modernize and revamp Public API Docs (#41287)
Modernize docs using pydata_sphinx_theme

[Screen recording 2025-12-22 4.54.40 PM.webm](https://github.com/user-attachments/assets/58b5254f-1357-4c09-9278-fb4763b5337d)

Also visible in Dark mode. (default is auto based on system settings)
<img width="2560" height="1440" alt="Screenshot 2025-12-22 5 01 55 PM" src="https://github.com/user-attachments/assets/f11e3705-d92c-4dfc-85d9-b09ae6a83661" />

Closes #41287

PiperOrigin-RevId: 857006550
2026-01-16 00:28:13 -08:00
Ashesh Vidyut
36c776b68b Fix gRPC Python docs website layout - use spaces optimally (#40073)
###  Description

Fix the gRPC Python docs website layout - using spaces optimally.

### Testing

https://github.com/user-attachments/assets/71294138-bf22-4497-975d-ef3b67cddef2

Closes #40073

COPYBARA_INTEGRATE_REVIEW=https://github.com/grpc/grpc/pull/40073 from asheshvidyut:feature/docs/python-html-layout 68444d45d3cc9bf028baffa1d750140828496d15
PiperOrigin-RevId: 778759809
2025-07-02 22:22:21 -07:00
paskozdilar
5b3da1a630 [doc] Update glossary link to grpc_arg_keys (#34771)
I have created an [issue on grpc.io
repository](https://github.com/grpc/grpc.io/issues/1212), and they have
pointed me towards this repository.

Currently, in the Python documentation glossary, the [channel
arguments](https://grpc.github.io/grpc/python/glossary.html#term-channel_arguments)
section contains a link to [header file
grpc_types.h](https://github.com/grpc/grpc/blob/v1.58.x/include/grpc/impl/codegen/grpc_types.h)
which is almost empty, and doesn't contain relevant information.

This PR fixes the invalid link in the Python glossary of gRPC
documentation, by replacing it with
[channel_arg_names.h](https://github.com/grpc/grpc/blob/v1.58.x/include/grpc/impl/channel_arg_names.h)
which contains the relevant information.
2023-10-31 16:08:08 -07:00
AJ Heller
007c4073c8 [documentation] Fix documentation build script by mocking python dependencies (#32398)
cc @markdroth 


<!--

If you know who should review your pull request, please assign it to
that
person, otherwise the pull request would get assigned randomly.

If your pull request is for a specific language, please add the
appropriate
lang label.

-->
2023-02-15 09:43:20 -08:00
Lidi Zheng
c57a3792a0 Remove unused extension 2020-04-22 17:02:32 -07:00
Lidi Zheng
6b2239ed40 Generate corresponding grpc_types.h link 2020-04-22 16:56:42 -07:00
Lidi Zheng
e62afd7ed2 Polish the grpc_asyncio.rst 2020-02-14 11:01:48 -08:00
Lidi Zheng
5326f8623d Update sphinx configuration 2020-02-14 11:01:48 -08:00
Lidi Zheng
a7b2ed3b98 Add documentation for 'grpcio-status' package 2019-03-22 17:28:34 -07:00
Lidi Zheng
43599facf4 Channelz Python wrapper implementation
* Expose the C-Core API in Cython layer
* Handle the object translation
* Create a separate package for Channelz specifically
* Handle nullptr and raise exception if seen one
* Translate C++ Channelz unit tests
* Adding 5 more invalid query unit tests

Adding peripheral utility for grpcio-channelz package
* Add to `pylint_code.sh`
* Add to Python build script
* Add to artifact build script
* Add to Bazel
* Add to Sphinx module list
2018-11-27 17:27:39 -08:00
Lidi Zheng
cabe8d8f10 New Python documentation generation
* Use templates instead of generating them every time
* Theme changed
* Add grpc_* modules
* APIs grouped
* No documentation for class members without docstring
* Add docstring for status code
2018-11-06 18:07:03 -08:00