Skip to content
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

Add module docs for RTD generation #6397

Merged
merged 8 commits into from
Oct 16, 2024
Merged

Add module docs for RTD generation #6397

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c001902
Add module docs for RTD gen
mlxd Oct 15, 2024
083a171
Downgrade deps for older doc build pipeline
mlxd Oct 15, 2024
c41e240
Merge branch 'master' into labs_docs
mlxd Oct 15, 2024
94ca5a6
Change autosummary rules for labs page
mlxd Oct 16, 2024
64f553c
Merge branch 'master' into labs_docs
mlxd Oct 16, 2024
0afc0de
Update CL
mlxd Oct 16, 2024
74152c9
Merge branch 'labs_docs' of github.com:PennyLaneAI/pennylane into lab…
mlxd Oct 16, 2024
b10c5b1
Update pennylane/labs/__init__.py
mlxd Oct 16, 2024
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
9 changes: 9 additions & 0 deletions doc/code/qml_labs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
qml.labs
================

.. currentmodule:: pennylane.labs

.. automodapi:: pennylane.labs
:no-heading:
:include-all-objects:
:skip: TRACE
1 change: 1 addition & 0 deletions doc/index.rst
View file
Open in desktop
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
4 changes: 2 additions & 2 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ appdirs
autograd
autoray
jax==0.4.16
jaxlib==0.4.16
jaxlib==0.4.28
mlxd marked this conversation as resolved.
Show resolved Hide resolved
mistune==0.8.4
m2r2
numpy
Expand All @@ -22,7 +22,7 @@ sphinxcontrib-devhelp==1.0.2
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-serializinghtml==1.1.5
tensorflow==2.11.1; platform_machine == "x86_64"
tensorflow~=2.17.0; platform_machine == "x86_64"
mlxd marked this conversation as resolved.
Show resolved Hide resolved
tensorflow_macos==2.9.0; sys_platform == "darwin" and platform_machine == "arm64"
tensornetwork==0.3
toml
Expand Down
19 changes: 17 additions & 2 deletions pennylane/labs/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,23 @@
# 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 occcur, and no API stability is guaranteed.
Use at your own risk.
mlxd marked this conversation as resolved.
Show resolved Hide resolved

.. currentmodule:: pennylane.labs

.. autosummary::
:toctree: api


"""

__all__ = []
Loading