Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cmake/C++ support to ReadTheDocs documentation generation. #547

merged 17 commits into from Aug 7, 2019


Copy link

commented Jul 23, 2019

  • Upgrade the read the docs file to v2
  • add a conda file for readthedocs that installs cmake
  • make sure to include submodules when building documentation on RTD
  • cleans up various warnings in the docstrings and markdown files
  • ...and more things to true up to the new C++ code

@ssteinbach ssteinbach added this to the Public Beta 12 milestone Jul 23, 2019


This comment has been minimized.

Copy link

commented Jul 23, 2019

Codecov Report

Merging #547 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #547   +/-   ##
  Coverage   81.28%   81.28%           
  Files          72       72           
  Lines        2731     2731           
  Hits         2220     2220           
  Misses        511      511
Flag Coverage Δ
#py27 81.29% <ø> (ø) ⬆️
#py36 81.29% <ø> (ø) ⬆️
#py37 81.29% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1407f4a...b0ed545. Read the comment docs.

ssteinbach added some commits Aug 5, 2019

Add cmake pip package as dependency for RTD
Read the docs images don't seem to include cmake.  We'd like to allow
people to include whichever version of cmake they'd like, so rather than
make everyone depend on the cmake pip package, we make it a requirement
only for ReadTheDocs builds, using an environment variable they provide.

@ssteinbach ssteinbach changed the title Attempting to address the read the docs build failure Add cmake/C++ support to ReadTheDocs documentation generation. Aug 7, 2019

@ssteinbach ssteinbach added this to To Do in C++ API via automation Aug 7, 2019

@ssteinbach ssteinbach requested a review from jminor Aug 7, 2019


jminor approved these changes Aug 7, 2019

@ssteinbach ssteinbach merged commit c5bc94d into PixarAnimationStudios:master Aug 7, 2019

1 check passed

Travis CI - Pull Request Build Passed

C++ API automation moved this from To Do to Done Aug 7, 2019

@ssteinbach ssteinbach deleted the ssteinbach:readthedocs-cmake branch Aug 7, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
You can’t perform that action at this time.