search

ga4gh / ga4gh-schemas

Models and APIs for Genomic data. RETIRED 2018-01-24
http://ga4gh.org
Apache License 2.0
214 stars 114 forks source link

Fix make docs #759

Closed david4096 closed 7 years ago

david4096 commented 7 years ago

A bug in docutils was causing our documentation generation process to fail. This updates the sphinx requirement to 1.5.1, updates the environment.yml to use the latest protobuf, and adds make docs to the Travis.

Note that readthedocs appears to be having this same error. Changing the dev-requirements fixed it for a local build, but I will leave #757 open until RTD is working as well.

kozbo commented 7 years ago

The error on RTD reads as follows:

error: protobuf 3.1.0.post1 is installed but protobuf==3.0.0b3 is required by set(['ga4gh-client', 'ga4gh-schemas'])
david4096 commented 7 years ago

Thanks! that does seem like a useful error. Do you have a link to the build or what you did to generate it?

This is what I see in the build logs:

  File "/home/docs/checkouts/readthedocs.org/user_builds/schemas/conda/latest/lib/python2.7/site-packages/docutils/writers/_html_base.py", line 671, in depart_document
    assert not self.context, 'len(context) = %s' % len(self.context)
AssertionError: len(context) = 1

https://readthedocs.org/projects/ga4gh-schemas/builds/4769537/ https://readthedocs.org/projects/schemas/builds/4786945/ https://readthedocs.org/projects/schemas/builds/4787698/

Can you confirm you are now able to run make docs locally?

kozbo commented 7 years ago

I am able to make docs locally in both the server and schema repos.

The error that was posted earlier was from here: https://readthedocs.org/projects/ga4gh-reference-implementation/builds/4787616/

david4096 commented 7 years ago

Latest commit pins the sphinx version in RTD, which allows the build to complete https://readthedocs.org/projects/schemas/builds/4791112/ .