-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Closed
Labels
priority: p2Moderately-important priority. Fix may not be included in next release.Moderately-important priority. Fix may not be included in next release.
Description
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/sitedeployments.
Discussions
- How much data is available in Writers https://groups.google.com/forum/#!topic/sphinx-users/-J1IOOBd-0g
Resources
- http://www.arnebrodowski.de/blog/write-your-own-restructuredtext-writer.html
- https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
- https://github.com/sphinx-doc/sphinx
- https://bitbucket.org/birkenfeld/sphinx-contrib
Metadata
Metadata
Assignees
Labels
priority: p2Moderately-important priority. Fix may not be included in next release.Moderately-important priority. Fix may not be included in next release.