Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

[Python] Sphinx cannot handle indentation in proto comments #402

Closed
geigerj opened this issue Aug 19, 2016 · 0 comments
Closed

[Python] Sphinx cannot handle indentation in proto comments #402

geigerj opened this issue Aug 19, 2016 · 0 comments
Assignees
Labels
lang: python Issues specific to Python. priority: p2 Moderately-important priority. Fix may not be included in next release.

Comments

@geigerj
Copy link
Contributor

geigerj commented Aug 19, 2016

Observed behavior:

After fixing #401:

Build vision docs:

python execute_pipeline.py \
    --config "../googleapis/gapic/api/artman_vision.yaml,\
    ../googleapis/gapic/lang/doc.yaml" \
    --language python \
    GapicClientPipeline 
cd output
tox -e docs

fails with

/usr/local/google/home/jgeiger/repos/gapi-dev/artman/output/gcloud-python-cloud-vision/.tox/docs/lib/python2.7/site-packages/google/type/latlng_pb2.py:docstring of google.type.latlng_pb2.LatLng:13: ERROR: Unexpected indentation.

Cause

Docstring for LatLng contains indented code blocks.

Solution

For code blocks, we should be able to recognize and format them correctly; this is tracked as #222. However, we still need a solution in the general case of indentation; for example, bigtable protos have indentation that is not a code block.

/cc @bjwatson

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lang: python Issues specific to Python. priority: p2 Moderately-important priority. Fix may not be included in next release.
Projects
None yet
Development

No branches or pull requests

1 participant