Skip to content

Commit

Permalink
Add module docs for RTD generation (#6397)
Browse files Browse the repository at this point in the history
### Before submitting

Please complete the following checklist when submitting a PR:

- [x] All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to
the
      test directory!

- [x] All new functions and code must be clearly commented and
documented.
If you do make documentation changes, make sure that the docs build and
      render correctly by running `make docs`.

- [x] Ensure that the test suite passes, by running `make test`.

- [x] Add a new entry to the `doc/releases/changelog-dev.md` file,
summarizing the
      change, and including a link back to the PR.

- [x] The PennyLane source code conforms to
      [PEP8 standards](https://www.python.org/dev/peps/pep-0008/).
We check all of our code against [Pylint](https://www.pylint.org/).
      To lint modified files, simply `pip install pylint`, and then
      run `pylint pennylane/path/to/file.py`.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


------------------------------------------------------------------------------------------------------------

**Context:** Adds module-level documentation for `qml.labs` 

**Description of the Change:**

**Benefits:**

**Possible Drawbacks:**

**Related GitHub Issues:**

---------

Co-authored-by: Josh Izaac <josh146@gmail.com>
  • Loading branch information
2 people authored and mudit2812 committed Nov 11, 2024
1 parent b1d7f20 commit 3351660
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 2 deletions.
7 changes: 7 additions & 0 deletions doc/code/qml_labs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
qml.labs
================

.. currentmodule:: pennylane.labs

.. automodule:: pennylane.labs

1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ PennyLane is **free** and **open source**, released under the Apache License, Ve
code/qml_fourier
code/qml_gradients
code/qml_kernels
code/qml_labs
code/qml_logging
code/qml_math
code/qml_noise
Expand Down
3 changes: 3 additions & 0 deletions doc/releases/changelog-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@

<h3>Improvements 🛠</h3>

* RTD support for `qml.labs` added to API.
[(#6397)](https://github.com/PennyLaneAI/pennylane/pull/6397)

* Module-level sandboxing added to `qml.labs` via pre-commit hooks.
[(#6369)](https://github.com/PennyLaneAI/pennylane/pull/6369)

Expand Down
22 changes: 20 additions & 2 deletions pennylane/labs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,26 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
""":code:`pennylane/labs/` module contains experimental features enabling
advanced quantum computing research."""
r"""
.. currentmodule:: pennylane
This module module contains experimental features enabling
advanced quantum computing research.
.. warning::
This module is experimental. Frequent changes will occur,
with no guarantees of stability or backwards compatibility.
.. currentmodule:: pennylane.labs
Modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api
"""

__all__ = []

0 comments on commit 3351660

Please sign in to comment.