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

Fix broken API documentation #14

Merged
merged 12 commits into from
Jun 5, 2024
Merged

Fix broken API documentation #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3248a69
remove apidoc from gitignore
May 22, 2024
ff0476a
remove pdf format
May 22, 2024
85c7a90
fix rtd pyhton version
May 22, 2024
4154084
add python version to dependencies
May 22, 2024
68a262b
Revert "add python version to dependencies"
May 22, 2024
96b2345
Revert "fix rtd pyhton version"
May 22, 2024
7598d1c
revert changes
May 22, 2024
a5b7608
remove sys path
May 22, 2024
1926f40
add modules to prevent warning
May 22, 2024
6ee0aa8
change template
May 22, 2024
0e62c2c
altered template apidocs
May 22, 2024
a9f7d67
remove toctree and template
May 26, 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
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ MANIFEST
src/qutip_qoc/version.py

# Documentation
doc/apidoc/*.rst
doc/.DS_Store

# PyInstaller
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ conda:

sphinx:
configuration: doc/conf.py
fail_on_warning: false
fail_on_warning: true
13 changes: 5 additions & 8 deletions doc/apidoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
qutip\_qoc package
===================


.. toctree::
:maxdepth: 1


High-level interfaces
---------------------
High-level interfaces to the optimal control features.

.. autosummary::
:toctree: apidoc/
:template: apidoc/module.rst

qutip_qoc.pulse_optim

Expand All @@ -22,8 +18,6 @@ Utilities
Optimal control utility functions.

.. autosummary::
:toctree: apidoc/
:template: apidoc/module.rst

qutip_qoc.result
qutip_qoc.objective
Expand All @@ -33,12 +27,15 @@ Low-level interfaces
Internal interfaces to the optimal control features.

.. autosummary::
:toctree: apidoc/
:template: apidoc/module.rst

qutip_qoc._optimizer
qutip_qoc._goat
qutip_qoc._jopt
qutip_qoc._grape
qutip_qoc._crab
qutip_qoc._time

.. toctree::
:hidden:

apidoc/modules
7 changes: 7 additions & 0 deletions doc/apidoc/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
qutip_qoc
=========

.. toctree::
:maxdepth: 4

qutip_qoc
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc._crab.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.\_crab module
========================

.. automodule:: qutip_qoc._crab
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc._goat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.\_goat module
========================

.. automodule:: qutip_qoc._goat
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc._grape.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.\_grape module
=========================

.. automodule:: qutip_qoc._grape
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc._jopt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.\_jopt module
========================

.. automodule:: qutip_qoc._jopt
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc._optimizer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.\_optimizer module
=============================

.. automodule:: qutip_qoc._optimizer
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc._time.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.\_time module
========================

.. automodule:: qutip_qoc._time
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc.objective.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.objective module
===========================

.. automodule:: qutip_qoc.objective
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc.pulse_optim.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.pulse\_optim module
==============================

.. automodule:: qutip_qoc.pulse_optim
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc.result.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.result module
========================

.. automodule:: qutip_qoc.result
:members:
:undoc-members:
:show-inheritance:
:private-members:
28 changes: 28 additions & 0 deletions doc/apidoc/qutip_qoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
qutip\_qoc package
==================

Submodules
----------

.. toctree::
:maxdepth: 4

qutip_qoc._crab
qutip_qoc._goat
qutip_qoc._grape
qutip_qoc._jopt
qutip_qoc._optimizer
qutip_qoc._time
qutip_qoc.objective
qutip_qoc.pulse_optim
qutip_qoc.result
qutip_qoc.version

Module contents
---------------

.. automodule:: qutip_qoc
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/apidoc/qutip_qoc.version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
qutip\_qoc.version module
=========================

.. automodule:: qutip_qoc.version
:members:
:undoc-members:
:show-inheritance:
:private-members:
2 changes: 0 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@
import pathlib
import sys

sys.path.insert(0, os.path.abspath("."))
sys.path.insert(0, os.path.abspath("../src"))
sys.path.insert(0, os.path.abspath("../src/qutip_qoc"))

# -- Project information -----------------------------------------------------
Expand Down
Loading