Documentation Uploader for Client Libraries

This tool uploads documentation for publishing to googleapis.dev and cloud.google.com (see doc-templates and doc-pipeline for more info).

Installation

You can install docuploader with:

pip install gcp-docuploader

Usage

There are two steps for uploading docs:

1. Create a metadata file. See metadata.proto for the format.
   • You can use docuploader create-metadata to create a docs.metadata file.
   • Alternatively, you can create a docs.metadata.json file independently.
2. Upload the docs with docuploader upload:

   Usage: docuploader upload [OPTIONS] DOCUMENTATION_PATH
   
   Options:
   --staging-bucket TEXT      The bucket to upload the staged documentation to.
   --credentials TEXT         Path to the credentials file to use for Google
                              Cloud Storage.
   
   --metadata-file TEXT       Path to the docs.metadata file. The path must be
                              relative to the CWD.
   
   --destination-prefix TEXT  Prefix to include when uploading tar file. A -
                              will be added after the prefix, if there is one.
   
   --help                     Show this message and exit.
   

docuploader can use ADC (Application Default Credentials) or a given service account. To use ADC, run gcloud auth application-default login prior to upload to gain credentials.

For an example of using docuploader, see example usage in googleapis/google-cloud-go.