Commit Graph

58 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
Xuan Wang
ca36ff84ba [Python o11y] Fix readme (#35988)
Fix `readme.rst`.

Tested locally by running `python setup.py doc`, no more errors from observability.

Only error is related to grpc_status:
```
WARNING: autodoc: failed to import module 'rpc_status' from module 'grpc_status'; the following exception was raised:
cannot import name 'status_pb2' from 'google.rpc' (unknown location)
```

<!--

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.

-->

Closes #35988

PiperOrigin-RevId: 609820414
2024-02-23 13:26:20 -08:00
Xuan Wang
1afcc3bd13 [Python O11y] Build and distrib O11y package (#35578)
Actually build O11y artifacts.

### Testing
* Manually installed the `.whl` and verified it's working locally (For Python 3.8 + Linux).

<!--

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.

-->

Closes #35578

PiperOrigin-RevId: 600566829
2024-01-22 14:18:12 -08:00
y-yagi
c019835d6f [doc] Fix a broken link to ProtoReflectionDescriptorDatabase (#35204)
Closes #35204

COPYBARA_INTEGRATE_REVIEW=https://github.com/grpc/grpc/pull/35204 from y-yagi:patch-1 7c5d9e6fa6e906fd84fac5abe33fce1b9cc7ad7a
PiperOrigin-RevId: 591176455
2023-12-15 01:17:51 -08: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
Xuan Wang
1138e3f83b [Documentation] Fix Python documentation CSS (#33908)
Fix python documentation website sidebar.

### Before:
<img width="1168" alt="Screenshot 2023-07-27 at 4 49 25 PM"
src="https://github.com/grpc/grpc/assets/24593237/1434ac63-7fc3-4f5c-a931-9a939fb67de6">

### After:
![Screenshot 2023-07-28 at 1 04 01
PM](https://github.com/grpc/grpc/assets/24593237/c7cc16b6-926f-4c8b-bc54-6cedfebb62b4)


<!--

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-07-31 09:58:33 -07:00
Xuan Wang
40f20c0f48 [Python fix-it][Aysnc Example] Adding examples for aysnc interceptor context propagaton (#32840)
### Description

Fix https://github.com/grpc/grpc/issues/24470.

Adding one example which demonstrate the following use cases:

* Generate RPC ID on client side and propagate to server.
* Context propagation from client to server.
* Context propagation between different server interceptors and the
server handler.

## Use:

1. Start server: `python3 -m async_greeter_server_with_interceptor`
2. Start client: `python3 -m async_greeter_client`

### Expected Logs:

* On client side:

```
Sending request with rpc id: 73bb98beff10c2dd7b9f2252a1e2039e
Greeter client received: Hello, you!
```

* On server side:

```
INFO:root:Starting server on [::]:50051
INFO:root:Interceptor1 called with rpc_id: default
INFO:root:Interceptor2 called with rpc_id: Interceptor1-default
INFO:root:Handle rpc with id Interceptor2-Interceptor1-73bb98beff10c2dd7b9f2252a1e2039e in server handler.
```
2023-05-04 19:31:01 +00: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
tomerv
2953b4518a Add Python Reflection Client (#29085)
Implement ProtoReflectionDescriptorDatabase in Python to support
client-side reflection sevices.

See gRFC L95.
2022-03-29 15:25:25 -07:00
AJ Heller
36824bc570 Revert "Revert "Revert "Add Python Reflection Client (#28443)" (#28878)" (#28879)" (#29023)
This reverts commit cf9be3d49d.
2022-03-04 10:09:11 -08:00
Lidi Zheng
cf9be3d49d Revert "Revert "Add Python Reflection Client (#28443)" (#28878)" (#28879)
This reverts commit 1b4b3764ba.
2022-03-02 14:52:47 -08:00
AJ Heller
1b4b3764ba Revert "Add Python Reflection Client (#28443)" (#28878)
This reverts commit 3e8e229308.
2022-02-14 16:00:44 -08:00
tomerv
3e8e229308 Add Python Reflection Client (#28443)
* Add Python Reflection Client

Implement ProtoReflectionDescriptorDatabase in Python to support
client-side reflection sevices.

* fixup: following code review

* fixup: following code review

Mostly improve documentation.

* fixup: add test to tests.json

* fixup: formatter & linter
2022-02-14 11:22:57 -08:00
Lidi Zheng
25f5399b41 Add grpcio-admin Python package (#26166)
* Add grpcio-admin Python package

* Polish package content

* Make Linux artifact build happy

* Improve documentation
2021-05-05 13:20:50 -07:00
Lidi Zheng
3de737cf8f Add Metadata to our doc generation (#25922) 2021-04-07 14:14:28 -07:00
Lidi Zheng
b65679bb74 Include AsyncIO interceptors in generated doc 2020-11-13 15:56:34 -08:00
Patrice Chalin
d109c5be50 Link to Python gRPC page on grpc.io
The newly updated [gRPC Python](https://grpc.io/docs/languages/python/) page, contains links to the quick start, tutorial, examples and more! Link directly to that page, rather than refer to only part of its contents.
2020-11-11 19:37:03 -05:00
Lidi Zheng
7c8d1b2150 Remove the experimental prefix for asyncio API in Sphinx rst script 2020-09-30 15:55:35 -07:00
Richard Belleville
8f1e181189 Merge remote-tracking branch 'origin/master' into dynamic_stubs 2020-08-06 12:32:47 -07:00
Richard Belleville
2c1efcd0ae Add documentation 2020-08-06 12:25:21 -07:00
Richard Belleville
0eabc3ec74 Add to Python documentation 2020-07-13 23:12:39 +00:00
Lidi Zheng
b9088ee9dd Address comments 2020-06-23 15:56:25 -07:00
Lidi Zheng
8bcffaa5ca Hide init_grpc_aio and guard async API outside of AsyncIO context 2020-06-23 12:10:18 -07:00
Jan Tattermusch
89be9c27f1 Merge pull request #23220 from chalin/chalin-docs-fix-grpc-io-links-200616
Docs: fix links to grpc.io quick start, tutorial and other pages
2020-06-22 14:11:53 +01:00
Yash Tibrewal
456036d808 Merge pull request #21959 from furukawa3/rm-trailing-spaces
Remove trailing-spaces from doc/*
2020-06-18 12:54:49 -07:00
Patrice Chalin
5ac3aa789f Docs: fix links to grpc.io tutorial pages 2020-06-16 08:47:24 -04:00
Patrice Chalin
4c4933e056 Docs: fix links to quick start pages 2020-06-16 08:40:59 -04:00
Lidi Zheng
004a3c3253 Weaken our promise 2020-04-23 14:16:36 -07:00
Lidi Zheng
dc3eb43ae6 It might be experimental 2020-04-23 10:22:34 -07:00
Lidi Zheng
6c2542150c Format the rst file 2020-04-22 17:03:39 -07: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
d3805e1b6c Explain how to find channel arguments in our doc 2020-04-22 16:19:42 -07:00
Lidi Zheng
f7d71ccfa6 Update the glossary 2020-04-22 14:51:21 -07:00
Lidi Zheng
c1df38f2b9 Document wait_for_ready mechanism in Python's glossary 2020-04-22 13:38:22 -07:00
Lidi Zheng
6e0ac50b09 Improve the documentation for serializer and deserializer 2020-04-15 14:04:52 -07:00
Lidi Zheng
12b0ddbc2b Improve the documentation based on suggestions 2020-02-14 11:03:27 -08:00
Lidi Zheng
1945c1108f Move the docstring from Cython to rst 2020-02-14 11:03:10 -08:00
Lidi Zheng
d743e4390a Fill-in missing interfaces & improve rst template 2020-02-14 11:03:10 -08: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
Yushiro FURUKAWA
61360c754b Remove trailing-spaces from doc/* 2020-02-10 23:53:33 +09:00
Richard Belleville
5ad654d5ab Merge pull request #19699 from curiousjazz77/patch-1
fix broken link and move links to bottom
2020-01-15 17:59:54 -08:00
Lidi Zheng
cc628584a6 Fix the Sphinx auto generation 2019-10-30 16:33:47 -07:00
Lidi Zheng
83ae68c5f0 Document the local credentials 2019-10-30 16:26:51 -07:00
curiousjazz77
e09e4d002d fix broken link and move links to bottom 2019-07-19 11:45:02 -07:00
Richard Belleville
f900eec41d Revert "Merge pull request #18727 from grpc/revert_compression"
This reverts commit 8054a731d1, reversing
changes made to c3d3cf8053.
2019-04-11 13:04:54 -07:00