Skip to content

docs: use autodoc_mock_imports for spt3g, so3g #165

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 14, 2020
Merged

docs: use autodoc_mock_imports for spt3g, so3g #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@OCS_DOC_BUILD=True $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2 changes: 2 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@
# Have __init__ and class docstrings both show up
autoclass_content = "both"

autodoc_mock_imports = ['spt3g', 'so3g']


# -- Options for HTML output -------------------------------------------------

Expand Down
11 changes: 3 additions & 8 deletions ocs/agent/aggregator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,8 @@

from ocs import ocs_feed

if os.getenv('OCS_DOC_BUILD') != 'True':
from spt3g import core
import so3g
G3Module = core.G3Module
else:
# Alias classes that are needed for clean import in docs build.
G3Module = object
from spt3g import core
import so3g


HKAGG_VERSION = 2
Expand Down Expand Up @@ -456,7 +451,7 @@ def to_frame(self, hksess=None, clear=False):
return frame


class G3FileRotator(G3Module):
class G3FileRotator(core.G3Module):
"""
G3 module which handles file rotation.
After time_per_file has elapsed, the rotator will end that file and create
Expand Down