Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Replaced epydoc with pydoctor #2425

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ Learn how to use the Google API Python Client with these guides:

### Reference Documentation

- Reference documentation for the core library [googleapiclient](http://googleapis.github.io/google-api-python-client/docs/epy/index.html).
- Reference documentation for the core library [googleapiclient](http://googleapis.github.io/google-api-python-client/docs/pydoc/index.html).
- [Library reference documentation by API](dyn/index.md).
4 changes: 2 additions & 2 deletions docs/batch.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ object in a batch request.
## Details
You create batch requests by calling `new_batch_http_request()` on your service
object, which returns a
[BatchHttpRequest](https://google.github.io/google-api-python-client/docs/epy/googleapiclient.http.BatchHttpRequest-class.html)
[BatchHttpRequest](https://google.github.io/google-api-python-client/docs/pydoc/googleapiclient.http.BatchHttpRequest.html)
object, and then calling `add()` for each request you want to execute.
You may pass in a callback with each request that is called with the response to that request.
The callback function arguments are:
Expand All @@ -39,7 +39,7 @@ You can also supply a single callback that gets called for each response:
<pre class="prettyprint">See below</pre>

The
[add()](https://google.github.io/google-api-python-client/docs/epy/googleapiclient.http.BatchHttpRequest-class.html#add)
[add()](https://google.github.io/google-api-python-client/docs/pydoc/googleapiclient.http.BatchHttpRequest.html#add)
method also allows you to supply a <code>request_id</code> parameter for each request.
These IDs are provided to the callbacks.
If you don't supply one, the library creates one for you.
Expand Down
2 changes: 1 addition & 1 deletion docs/build
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@
export GOOGLE_APPENGINE=$HOME/projects/google_appengine/
export DJANGO_SETTINGS_MODULE=fakesettings
export PYTHONPATH=$(pwd)/..:$GOOGLE_APPENGINE
epydoc --output epy --graph all --parse-only --docformat plaintext googleapiclient
pydoctor --html-output=pydoc --docformat=google googleapiclient
392 changes: 0 additions & 392 deletions docs/epy/api-objects.txt

This file was deleted.

267 changes: 0 additions & 267 deletions docs/epy/class-tree.html

This file was deleted.

Binary file removed docs/epy/crarr.png
Binary file not shown.
Loading