Skip to content

Conversation

mhasself
Copy link
Member

@mhasself mhasself commented Sep 9, 2020

Description

This allows autodoc to run on readthedocs... without the OCS_DOC_BUILD business I put in before. The aggregator API stuff has not been rendering since HK v2 went in.

Motivation and Context

Recent builds on readthedocs have been failing to process the aggregator.py source file, because some spt3g core.G3* classes were being accessed on import. sphinx has a feature to dodge this. For example, the API section is totally empty.

How Has This Been Tested?

Tested that the docs build locally even if so3g or spt3g aren't available.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • Unless I am preparing a release, I have opened this PR onto the develop branch.

This allows autodoc to run on readthedocs... without the OCS_DOC_BUILD
business I put in before.  The aggregator API stuff has not been
rendering since HK v2 went in.
@BrianJKoopman BrianJKoopman self-requested a review September 9, 2020 21:15
Copy link
Member

@BrianJKoopman BrianJKoopman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Looks much less prone to breakage than the other work around. Would be great to do the same on socs.

@BrianJKoopman BrianJKoopman merged commit fb638ba into develop Sep 14, 2020
@BrianJKoopman BrianJKoopman deleted the mock-for-readthedocs branch September 14, 2020 16:52
@BrianJKoopman BrianJKoopman mentioned this pull request Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants