Merge pull request #80 from dihm/updates

dihm · web-flow · commit 35ce09314d0c · 2023-10-08T13:56:15.000-04:00
Minor updates
diff --git a/docs/source/installation/Copymasterbranchonly.png b/docs/source/installation/Copymasterbranchonly.png
diff --git a/docs/source/installation/developer-anaconda.rst b/docs/source/installation/developer-anaconda.rst
@@ -36,7 +36,7 @@ Quick start
     (base) > git clone https://github.com/wkheisenberg/labscript-devices
     (base) > git clone https://github.com/wkheisenberg/labscript-utils
     (base) > conda activate py38
-    (py38) > conda config --env --add channels labscript-suite
+    (py38) > conda config --env --append channels labscript-suite
     (py38) > conda install setuptools-conda pyqt pip desktop-app
     (py38) > setuptools-conda install-requirements ^ 
              labscript runmanager blacs lyse runviewer labscript-devices labscript-utils
@@ -54,6 +54,18 @@ The following is a detailed explanation of the steps provided in the Quick start
 #. Fork the labscript-suite repositories you want to develop using the `GitHub online interface <https://help.github.com/en/github/getting-started-with-github/fork-a-repo>`_. 
    Below we will include all repositories (except the labscript-suite metapackage).
 
+   .. attention:: 
+
+     Recent `changes in Github's online interface <https://github.blog/changelog/2022-07-27-you-can-now-fork-a-repo-and-copy-only-the-default-branch/>`_
+     mean that version tags are not copied into new forks by default.
+     These tags are necessary to properly resolve component versions when installing from your fork.
+     To override this behavior, ensure the `Copy master branch only` checkbox is **unchecked**.
+
+     .. image:: Copymasterbranchonly.png
+          :width: 400
+          :align: center
+          :alt: Unselect this option to copy version tags too 
+
 #. Manually clone the forked repositories using |GitClone|_.
 
    .. note::
diff --git a/docs/source/installation/developer-pypi.rst b/docs/source/installation/developer-pypi.rst
@@ -34,6 +34,18 @@ The following is a detailed explanation of the steps provided in the Quick start
 
 1. Fork the labscript-suite repositories you want to develop using the `GitHub online interface <https://help.github.com/en/github/getting-started-with-github/fork-a-repo>`_. Below we will include all repositories (except the labscript-suite metapackage).
 
+   .. attention:: 
+
+     Recent `changes in Github's online interface <https://github.blog/changelog/2022-07-27-you-can-now-fork-a-repo-and-copy-only-the-default-branch/>`_
+     mean that version tags are not copied into new forks by default.
+     These tags are necessary to properly resolve component versions when installing from your fork.
+     To override this behavior, ensure the `Copy master branch only` checkbox is **unchecked**.
+
+     .. image:: Copymasterbranchonly.png
+          :width: 400
+          :align: center
+          :alt: Unselect this option to copy version tags too 
+
 
 .. The below is a hack in order to make a code block also a hyperlink, see https://docutils.sourceforge.io/docs/ref/rst/directives.html#replace
 
diff --git a/docs/source/installation/regular-anaconda.rst b/docs/source/installation/regular-anaconda.rst
@@ -11,7 +11,7 @@ Quick start
 .. code-block:: console
 
     (base) C:\> conda activate py38
-    (base) C:\> conda config --env --add channels labscript-suite
+    (base) C:\> conda config --env --append channels labscript-suite
     (py38) C:\> conda install labscript-suite pyqt
     (py38) C:\> labscript-profile-create
     (py38) C:\> desktop-app install blacs lyse runmanager runviewer
diff --git a/readthedocs.yaml b/readthedocs.yaml
@@ -23,5 +23,4 @@ python:
         path: .
         extra_requirements:
             - docs
-   system_packages: true
    
