aboutsummaryrefslogtreecommitdiff
path: root/describe.py
AgeCommit message (Collapse)Author
2021-07-14chore: code clean up (#1442)arfy slowy
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) Fixes #1441 🦕
2021-05-27fix: resolve issue where certain artifacts would not be updated (#1385)Anthonios Partheniou
2021-04-21chore: add scripts to update discovery artifacts (#1286)Anthonios Partheniou
These PR add the scripts from #1187 that are needed to update discovery artifacts using a Github action. The scripts will be removed from #1187 once all of the review comments from #1187 have been resolved. This PR adds the following files under the `scripts/` folder - `README.md` to provide instructions on manually updating discovery artifacts and API reference documentation. - `buildprbody.py` creates a summary of the changes detected in discovery artifacts and writes them to `allapis.summary`. - `changesummary.py` creates verbose change information for each API with discovery artifact changes. - `createcommits.sh` creates git commits for each API with discovery artifact changes or reference document changes. - `updatediscoveryartifacts.py` is the python file that can be used to update discovery artifacts. I also moved `describe.py` under the scripts folder and modified it to save the discovery artifacts that are fetched. TODO: - [x] Add tests for scripts - [x] Address review comments in #1187
2021-01-14feat: Add support for using static discovery documents (#1109)Anthonios Partheniou
* feat: Add support for static discovery documents * Auto generated docs should use static artifacts
2020-12-16docs: fix regression with incorrect args order in docs (#1141)Anthonios Partheniou
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) Fixes #1140 🦕
2020-12-14docs: Reduce noisy changes in docs regen (#1135)Anthonios Partheniou
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) Fixes #386 🦕
2020-11-16build: run docs regen in synth.py (#1059)Bu Sun Kim
2020-08-03docs: fix deprecation warnings due to invalid escape sequences. (#996)Karthikeyan Singaravelan
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes #995 🦕
2020-07-22docs: update generated docs (#981)Bu Sun Kim
2020-05-01chore: regens API reference docs (#889)Dan O'Meara
2020-04-21docs: fix unescaped html tag (#802)Billy SU
If the description of the method contains any HTML tag, it will break the HTML rendering. This commit escapes the html tag to prevent this problem. * Use html standard lib when using python3 * Use cgi standard lib when using python2 Refs #791 Release-As: 1.8.2
2020-04-20docs: support python3 to generate docs (#801)Billy SU
Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com>
2019-10-30chore: blacken (#772)Bu Sun Kim
2019-07-22Use print() function in both Python 2 and Python 3 (#722)Christian Clauss
* Use print() function in both Python 2 and Python 3 Legacy __print__ statements are syntax errors in Python 3 but __print()__ function works as expected in both Python 2 and Python 3. * Fix undefined names
2019-07-17Create index file for dynamically generated docs. (#702)Bu Sun Kim
2019-06-14Regen all docs. (#700)Bu Sun Kim
* Stop recursing if discovery == {} * Generate docs with 'make docs'.
2017-03-27Fix method doc signatures for multiline required parameters (#374)Thomas Coffee
* Fix method doc signatures for multiline required parameters. Existing doc generator failed to recognize parameters as required when parameter descriptions extended over more than one line. Besides presenting incorrect information, resulting inconsistencies broke checks for automated sample generation. * Regen docs
2017-01-19Set default HTTP timeout of 60s (#320)Igor Maravić
2016-10-21Refresh all docs (#298)Sai Cheemalapati
Change the discovery query to fetch all discovery docs, not just the preferred ones.
2016-02-19Fix issue where docs would fail to build if an API is whitelisted.Jon Wayne Parrott
2014-09-23Update copyright lines.Craig Citro
2014-08-18Use json from the stdlib.Craig Citro
2014-04-24Transition apiclient from googlecode to github.John Asmuth
2013-03-29Start removing dependence on gflags.Joe Gregorio
Reviewed in https://codereview.appspot.com/7628044/. This only removes the dependency from the core library, a second CL will update all the samples.
2013-03-07Refresh docsJoe Gregorio
2013-03-03Add some command-line flags to control describe.Joe Gregorio
Reviewed in https://codereview.appspot.com/7438047/
2012-11-05Refresh docsJoe Gregorio
2012-07-10Use anyjson consistently.Joe Gregorio
Reviewed in http://codereview.appspot.com/6343090/.
2012-07-09Refresh generated docs.Joe Gregorio
2012-07-09Build cleaner and easier to read docs for dynamic surfaces.Joe Gregorio
Reviewed in http://codereview.appspot.com/6376043/.
2012-02-21Update generated docs.Joe Gregorio
2011-04-01Updated copyright notices where appropriate and refreshed generated docs.Joe Gregorio
2011-02-20Use html output of pydoc in api-python-client-doc application. Also generate ↵Joe Gregorio
a static linked set of documents for all apis that we know about.