tidy docs

Author: gilesknap

.vscode/tasks.json

@@ -6,7 +6,7 @@
         {
             "type": "shell",
             "label": "Tests with coverage",
-            "command": "pipenv run tests",
+            "command": "tox -e pytest",
             "options": {
                 "cwd": "${workspaceRoot}"
             },

CONTRIBUTING.rst

@@ -39,7 +39,7 @@ on your workstation as follows::
 
 In both cases tox -p runs in parallel the following checks:
 
-  - Build Spinx Documentation
+  - Build Sphinx Documentation
   - run pytest on all tests in ./tests
   - run mypy linting on all files in ./src ./tests
   - run pre-commit checks:
@@ -126,10 +126,14 @@ Release Process
 To make a new release, please follow this checklist:
 
 - Choose a new PEP440 compliant release number
-- Git tag the version
-- Push to GitHub and the actions will make a release on pypi
-- Push to internal gitlab and do a dls-release.py of the tag
-- Check and edit for clarity the autogenerated GitHub release_
+- Go to the GitHub release_ page
+- Choose ``Draft New Release``
+- Click ``Choose Tag`` and supply the new tag you chose (click create new tag)
+- Click ``Generate release notes``, review and edit these notes
+- Choose a title and click ``Publish Release``
+
+Note that tagging and pushing to the main branch has the same effect except that
+you will not get the option to edit the release notes.
 
 .. _release: https://github.com/epics-containers/python3-pip-skeleton/releases
 
@@ -149,7 +153,7 @@ Python project structure which provides a means to keep tools and
 techniques in sync between multiple Python projects. To update to the
 latest version of the skeleton, run::
 
-    $ git pull https://github.com/dls-controls/python3-pip-skeleton skeleton
+    $ git pull https://github.com/dls-controls/python3-pip-skeleton main
 
 Any merge conflicts will indicate an area where something has changed that
 conflicts with the setup of the current module. Check the `closed pull requests

README.rst

@@ -9,6 +9,8 @@ python3-pip-skeleton
     adopt this skeleton project see 
     https://epics-containers.github.io/python3-pip-skeleton-cli
 
+    [Remove this note when adopting skeleton.]
+
 This is where you should write a short paragraph that describes what your module does,
 how it does it, and why people should use it.
 

docs/tutorials/installation.rst

@@ -1,16 +1,6 @@
 Installation
 ============
 
-.. note::
-
-    For installation inside DLS, please see the internal documentation on
-    ``dls-python3`` and ``pipenv``. Although these instructions will work
-    inside DLS, they are intended for external use.
-
-    If you want to contribute to the library itself, please follow
-    the `../how-to/contributing` instructions.
-
-
 Check your version of python
 ----------------------------