Skip to content

Add JSON Documentation #2352

@daspecster

Description

@daspecster

This issue is for tracking the requirements, issues and solutions in generating JSON for the gcloud-common Angular site.

Known Requirements

  • Extracting sphinx code examples and place them in methods[{examples:[]}].
  • Generate table of contents from sphinx toc. (index.rst).
  • Class linking should be added. i.e. support :class:gcloud.datastore._generated.query_pb2.Query, this is partially done through types.json.
  • Source code links (base on relative repo path. i.e. /google/cloud/datastore/client.py#L25).
  • "Getting Started" and "Guide" type pages need to be ported.
  • Ensure that snippets are pulled in properly from docs/*_snippets.py.
  • Turn on auto gcloud-common/site deployments.

Discussions

Resources

Metadata

Metadata

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions