Adding docs

borkweb · borkweb · commit b1c6eabad600 · 2024-04-27T13:29:39.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -24,6 +24,7 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+arrayutils.md
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
diff --git a/docs/generating-docs.md b/docs/generating-docs.md
@@ -0,0 +1,8 @@
+# Generating docs
+
+This is just a helper file to explain how to generate docs.
+
+1. `pydoc-markdown -I arrayutils -m Arr --render-toc > arrayutils.md`
+2. Copy/paste docs into README
+3. Replace `#__init__.Arr.` with `#usage.`
+4. Remove some of the extraneous elements at the top.
diff --git a/docs/publishing.md b/docs/publishing.md
@@ -0,0 +1,6 @@
+# Publishing
+
+This is just a helper doc with info on publishing to pypi.org.
+
+1. `python -m build`
+2. `python -m twine upload --repository pypi dist/*`
