diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst index b0533e1..a0a6cfd 100644 --- a/docs/apidocs/index.rst +++ b/docs/apidocs/index.rst @@ -1,6 +1,6 @@ -****************************** -qiskit-addon-sqd API reference -****************************** +********************************** +``qiskit-addon-sqd`` API reference +********************************** .. toctree:: :maxdepth: 1 diff --git a/qiskit_addon_sqd/__init__.py b/qiskit_addon_sqd/__init__.py index 0154b73..e872c06 100644 --- a/qiskit_addon_sqd/__init__.py +++ b/qiskit_addon_sqd/__init__.py @@ -10,4 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. +# Warning: this module is not documented and it does not have an RST file. +# If we ever publicly expose interfaces users can import from this module, +# we should set up its RST file. """Primary SQD functionality."""