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.

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 function page titles to documentation #108

Merged
merged 1 commit into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion docs/densitytensor.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
densitytensor
Mixed state simulation
=======================

.. toctree::
:titlesonly:

densitytensor/all_zeros_densitytensor
densitytensor/kraus
Expand Down
3 changes: 3 additions & 0 deletions docs/densitytensor/all_zeros_densitytensor.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
all_zeros_densitytensor
==============================================

.. autofunction:: qujax.all_zeros_densitytensor
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
densitytensor_to_measured_densitytensor
==============================================

.. autofunction:: qujax.densitytensor_to_measured_densitytensor
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
densitytensor_to_measurement_probabilities
==============================================

.. autofunction:: qujax.densitytensor_to_measurement_probabilities
3 changes: 3 additions & 0 deletions docs/densitytensor/get_densitytensor_to_expectation_func.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
get_densitytensor_to_expectation_func
==============================================

.. autofunction:: qujax.get_densitytensor_to_expectation_func
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
get_densitytensor_to_sampled_expectation_func
==============================================

.. autofunction:: qujax.get_densitytensor_to_sampled_expectation_func
3 changes: 3 additions & 0 deletions docs/densitytensor/get_params_to_densitytensor_func.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
get_params_to_densitytensor_func
==============================================

.. autofunction:: qujax.get_params_to_densitytensor_func
3 changes: 3 additions & 0 deletions docs/densitytensor/kraus.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
kraus
==============================================

.. autofunction:: qujax.kraus
3 changes: 3 additions & 0 deletions docs/densitytensor/partial_trace.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
partial_trace
==============================================

.. autofunction:: qujax.partial_trace
3 changes: 3 additions & 0 deletions docs/densitytensor/statetensor_to_densitytensor.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
statetensor_to_densitytensor
==============================================

.. autofunction:: qujax.statetensor_to_densitytensor
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Contents

.. toctree::
:caption: API Reference:
:titlesonly:

Pure state simulation <statetensor>
Mixed state simulation <densitytensor>
Expand Down
3 changes: 2 additions & 1 deletion docs/statetensor.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
statetensor
Pure state simulation
=======================

.. toctree::
:titlesonly:

statetensor/all_zeros_statetensor
statetensor/apply_gate
Expand Down
3 changes: 3 additions & 0 deletions docs/statetensor/all_zeros_statetensor.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
all_zeros_statetensor
==============================================

.. autofunction:: qujax.all_zeros_statetensor
3 changes: 3 additions & 0 deletions docs/statetensor/apply_gate.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
apply_gate
==============================================

.. autofunction:: qujax.apply_gate
3 changes: 3 additions & 0 deletions docs/statetensor/get_params_to_statetensor_func.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
get_params_to_statetensor_func
==============================================

.. autofunction:: qujax.get_params_to_statetensor_func
3 changes: 3 additions & 0 deletions docs/statetensor/get_params_to_unitarytensor_func.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
get_params_to_unitarytensor_func
==============================================

.. autofunction:: qujax.get_params_to_unitarytensor_func
3 changes: 3 additions & 0 deletions docs/statetensor/get_statetensor_to_expectation_func.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
get_statetensor_to_expectation_func
==============================================

.. autofunction:: qujax.get_statetensor_to_expectation_func
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
get_statetensor_to_sampled_expectation_func
==============================================

.. autofunction:: qujax.get_statetensor_to_sampled_expectation_func
4 changes: 2 additions & 2 deletions docs/utils.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
utils
Utility functions
=======================

.. toctree::
:titlesonly:

utils/bitstrings_to_integers
utils/check_circuit
Expand All @@ -10,4 +11,3 @@ utils
utils/repeat_circuit
utils/sample_bitstrings
utils/sample_integers

3 changes: 3 additions & 0 deletions docs/utils/bitstrings_to_integers.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
bitstrings_to_integers
==============================================

.. autofunction:: qujax.bitstrings_to_integers
3 changes: 3 additions & 0 deletions docs/utils/check_circuit.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
check_circuit
==============================================

.. autofunction:: qujax.check_circuit
3 changes: 3 additions & 0 deletions docs/utils/integers_to_bitstrings.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
integers_to_bitstrings
==============================================

.. autofunction:: qujax.integers_to_bitstrings
3 changes: 3 additions & 0 deletions docs/utils/print_circuit.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
print_circuit
==============================================

.. autofunction:: qujax.print_circuit
3 changes: 3 additions & 0 deletions docs/utils/repeat_circuit.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
repeat_circuit
==============================================

.. autofunction:: qujax.repeat_circuit
3 changes: 3 additions & 0 deletions docs/utils/sample_bitstrings.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
sample_bitstrings
==============================================

.. autofunction:: qujax.sample_bitstrings
3 changes: 3 additions & 0 deletions docs/utils/sample_integers.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
sample_integers
==============================================

.. autofunction:: qujax.sample_integers