Skip to content

Commit

Permalink
(Fixes OSS CI) Have Sphinx track deprecated_transform_mixin, but ma…
Browse files Browse the repository at this point in the history
…ke it private (#2330)

Summary:
Pull Request resolved: #2330

The OSS CI is failing: https://github.com/facebook/Ax/actions/runs/8581833037/job/23519269134?pr=2329

This should fix the Sphinx error. Adding `:meta private:` to the docstring will stop it from rendering, since OSS users shouldn't need to know about `DeprecatedTransformMixin` and can read the code on GH if they need to.

Reviewed By: Balandat

Differential Revision: D55837917

fbshipit-source-id: 9307d7e0795f5e8652ea9c1c9834be054bf2ad8e
  • Loading branch information
esantorella authored and facebook-github-bot committed Apr 6, 2024
1 parent b7e1fe2 commit adcf3a4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions ax/modelbridge/transforms/deprecated_transform_mixin.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ class DeprecatedTransformMixin:
class DeprecatedTransform(DeprecatedTransformMixin, NewTransform):
...
:meta private:
"""

def __init__(self, *args: Any, **kwargs: Any) -> None:
Expand Down
7 changes: 7 additions & 0 deletions sphinx/source/modelbridge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,13 @@ Dispatch Utilities

Transforms
----------
`ax.modelbridge.transforms.deprecated_transform_mixin`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: ax.modelbridge.transforms.deprecated_transform_mixin
:members:
:undoc-members:
:show-inheritance:

`ax.modelbridge.transforms.base`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit adcf3a4

Please sign in to comment.