Tweak README, regenerate documentation

lukasschwab · Jan 13, 2024 · 51f1acd · 51f1acd
1 parent 69ded9b
commit 51f1acd
Show file tree

Hide file tree

Showing 8 changed files with 1,583 additions and 1,858 deletions.
diff --git a/Makefile b/Makefile
@@ -16,7 +16,7 @@ audit:
 
 docs: docs/index.html
 docs/index.html: $(source) README.md
-	rm -rf docs/*
+	pdoc --version
 	pdoc --docformat "restructuredtext" jsonfeed jsonfeed.converters.feedparser -o docs
 
 clean:

diff --git a/README.md b/README.md
@@ -8,10 +8,16 @@ This package's constructor arguments and class variables exactly match the field
 
 ### Installation
 
-In this directory, run:
+Install this package with `pip`:
 
 ```shell
-$ pip install .
+$ pip install jsonfeed-util
+```
+
+In your Python code, include the line
+
+```python
+import jsonfeed
 ```
 
 ### Parsing a JSON feed

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/jsonfeed.html b/docs/jsonfeed.html
diff --git a/docs/jsonfeed/converters/feedparser.html b/docs/jsonfeed/converters/feedparser.html
diff --git a/docs/search.js b/docs/search.js
diff --git a/docs/search.json b/docs/search.json
diff --git a/requirements.txt b/requirements.txt
@@ -3,5 +3,6 @@ feedparser==6.0.2
 # Development dependencies
 pytest>=6.2.2
 flake8>=3.9.0
-pdoc==7.1.1
-pip-audit>=1.1.2
+pdoc==13.1.0
+pip-audit>=1.1.2
+