Skip to content

Commit

Permalink
Add ribs.emitters.operators to docs (#435)
Browse files Browse the repository at this point in the history
## Description

<!-- Provide a brief description of the PR's purpose here. -->

`ribs.emitters.operators` now shows up in the docs.

## TODO

<!-- Notable points that this PR has either accomplished or will
accomplish. -->

## Questions

<!-- Any concerns or points of confusion? -->

## Status

- [x] I have read the guidelines in

[CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md)
- [x] I have formatted my code using `yapf`
- [x] I have tested my code by running `pytest`
- [x] I have linted my code with `pylint`
- [N/A] I have added a one-line description of my change to the
changelog in
      `HISTORY.md`
- [x] This PR is ready to go
  • Loading branch information
btjanaka authored Dec 8, 2023
1 parent 45daa42 commit 449681d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/api/ribs.emitters.operators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ribs.emitters.operators
=======================

.. automodule:: ribs.emitters.operators
:no-members:
:no-inherited-members:
:no-special-members:
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ whats-new
api/ribs.archives
api/ribs.emitters
api/ribs.emitters.operators
api/ribs.emitters.opt
api/ribs.emitters.rankers
api/ribs.schedulers
Expand Down
2 changes: 2 additions & 0 deletions ribs/emitters/operators/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
.. autosummary::
:toctree:
ribs.emitters.operators.GaussianOperator
ribs.emitters.operators.IsoLineOperator
ribs.emitters.operators.OperatorBase
"""
from ribs.emitters.operators._gaussian import GaussianOperator
Expand Down

0 comments on commit 449681d

Please sign in to comment.