fix link

neutrons · Apr 26, 2024 · c88193b · c88193b
1 parent c23672a
commit c88193b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 14 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,12 +15,13 @@ experience when interacting with ONCat within Python applications.
 
 Getting Started
 ---------------
-Install instructions coming soon.
+To install PyONCatQt, run the following command:
 
+.. code-block:: bash
 
-.. note::
+   conda install -c neutrons pyoncatqt
 
-   This project is under active development.
+To use PyONCatQt please see the :ref:`sample` section for examples.
 
 Contents
 --------

diff --git a/docs/source/reference.rst b/docs/source/reference.rst
@@ -1,11 +1,11 @@
 Reference
 =========
 
-PyONCatQt
----------
+ONCatLogin
+----------
 
-.. module:: PyONCatQt
-.. automodule:: pyoncatqt.pyoncatqt
+.. module:: ONCatLogin
+.. automodule:: pyoncatqt.login.ONCatLogin
     :members:
 
 ONCatLoginDialog
@@ -14,10 +14,3 @@ ONCatLoginDialog
 .. module:: ONCatLoginDialog
 .. automodule:: pyoncatqt.login.ONCatLoginDialog
     :members:
-
-ONCatLogin
-----------
-
-.. module:: ONCatLogin
-.. automodule:: pyoncatqt.login.ONCatLogin
-    :members:
diff --git a/docs/source/sample.rst b/docs/source/sample.rst
@@ -1,3 +1,5 @@
+.. _sample:
+
 Sample Usage
 ============