build: notes about publishing docs and packages

README.md

@@ -2,8 +2,8 @@
 
 [![ci](https://github.com/csiro-hydroinformatics/pyrefcount/workflows/ci/badge.svg)](https://github.com/csiro-hydroinformatics/pyrefcount/actions?query=workflow%3Aci)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://csiro-hydroinformatics.github.io/pyrefcount/)
-
-[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/csiro-hydroinformatics/pyrefcount/blob/main/LICENSE.txt) ![status](https://img.shields.io/badge/status-stable-green.svg) [![Documentation Status](https://readthedocs.org/projects/pyrefcount/badge/?version=latest)](https://pyrefcount.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/gh/csiro-hydroinformatics/pyrefcount/branch/main/graph/badge.svg?token=ZBBFq3ncAq)](https://codecov.io/gh/csiro-hydroinformatics/pyrefcount)[![Python package](https://github.com/csiro-hydroinformatics/pyrefcount/actions/workflows/build-matrix.yml/badge.svg?branch=main)](https://github.com/csiro-hydroinformatics/pyrefcount/actions/workflows/build-matrix.yml)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/csiro-hydroinformatics/pyrefcount/blob/main/LICENSE.txt) ![status](https://img.shields.io/badge/status-stable-green.svg)
+[![codecov](https://codecov.io/gh/csiro-hydroinformatics/pyrefcount/branch/main/graph/badge.svg?token=ZBBFq3ncAq)](https://codecov.io/gh/csiro-hydroinformatics/pyrefcount)
 
 [![pypi version](https://img.shields.io/pypi/v/refcount)](https://pypi.org/project/refcount/)[![Conda Version](https://img.shields.io/conda/vn/conda-forge/refcount.svg)](https://anaconda.org/conda-forge/refcount)[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/refcount?label=conda-downloads)](https://anaconda.org/conda-forge/refcount)
 

docs/tech_notes.md

@@ -75,6 +75,28 @@ No fixes available (99 hidden fixes can be enabled with the `--unsafe-fixes` opt
 
 These are a bit of a bother. Type annotations, I think, encouraged e.g. the use of `List` instead of `list` years ago. This grates.
 
+### Deploying docs
+
+`make docs-deploy` requires mkdocs for insiders.  
+
+`mkdocs gh-deploy`:
+
+```
+ERROR   -  Config value 'markdown_extensions': Failed to load extension 'callouts'.
+           ModuleNotFoundError: No module named 'callouts'
+```
+
+This was because I had not activated the environment with `. ./.venv/bin/activate`
+
+```sh
+mkdocs build
+mkdocs gh-deploy
+```
+
+```sh
+make release version=1.2.7
+```
+
 ## Release steps
 
 * all UT pass

src/refcount/base.py

@@ -1,4 +1,4 @@
-"""Base classes forreference counting."""
+"""Base classes for reference counting."""
 
 from typing import Any