0.2.1 (#37)

* fix logo * doc anchor fixes, sent.py snippet fix, guide->usage * fix (hopefully) docs deploy workflow * release notes for 0.2.1
tallpauley · Jan 20, 2025 · 0ae54c7 · 0ae54c7
1 parent 2e2de32
commit 0ae54c7
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 24 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -17,13 +17,6 @@ jobs:
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs-material mkdocstrings-python
-      - run: mkdocs gh-deploy --force
+          python-version: 3.9
+      - run: poetry install --with docs
+      - run: poetry run mkdocs gh-deploy --force
diff --git a/docs/images/wordsiv-logo.png b/docs/images/wordsiv-logo.png
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,3 +1,9 @@
+## 0.2.1 – 2025-01-20
+
+### Fixed
+
+- minor docs/site issues
+
 ## 0.2.0 – 2025-01-20
 
 ### Added

diff --git a/docs/snippets/sent.py b/docs/snippets/sent.py
@@ -18,4 +18,4 @@
 print(wsv.sent(numbers=1, n_words=10))
 
 # 50% words, 50% numbers
-print(wsv.words(numbers=0.5, n_words=10))
+print(wsv.sent(numbers=0.5, n_words=10))
diff --git a/docs/guide/basic-usage.md → docs/usage/basic-usage.md b/docs/guide/basic-usage.md → docs/usage/basic-usage.md
diff --git a/docs/guide/filtering-words.md → docs/usage/filtering-words.md b/docs/guide/filtering-words.md → docs/usage/filtering-words.md
diff --git a/docs/guide/generating-text.md → docs/usage/generating-text.md b/docs/guide/generating-text.md → docs/usage/generating-text.md
@@ -2,14 +2,14 @@
 
 WordSiv provides several methods for generating text at different levels:
 
-- Word(s): [`word()`](#random-word-generation-word),
+- Word(s): [`word()`](#random-word-word),
   [`words()`](#list-of-random-words-words),
   [`top_word()`](#most-common-word-top_word),
   [`top_words()`](#list-of-most-common-words-top_words)
 - Sentence(s): [`sent()`](#sentence-sent), [`sents()`](#list-of-sentences-sents)
-- Paragraph(s): [`para()`](#paragraph-generation-para),
-  [`paras()`](#multiple-paragraphs-generation-paras)
-- Text Blocks: [`text()`](#full-text-block-generation-text)
+- Paragraph(s): [`para()`](#paragraph-para),
+  [`paras()`](#multiple-paragraphs-paras)
+- Text Blocks: [`text()`](#text-block-text)
 
 ## Text Generation Methods
 

diff --git a/docs/guide/punctuation.md → docs/usage/punctuation.md b/docs/guide/punctuation.md → docs/usage/punctuation.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,9 +30,9 @@ nav:
       - GJ-style Proof: examples/gj-style-proof.md
       - Init/Medi/Fina Proof: examples/init-medi-fina-proof.md
   - Usage:
-      - Basic Usage: guide/basic-usage.md
-      - Generating Text: guide/generating-text.md
-      - Filtering Words: guide/filtering-words.md
+      - Basic Usage: usage/basic-usage.md
+      - Generating Text: usage/generating-text.md
+      - Filtering Words: usage/filtering-words.md
   - API Reference:
       wordsiv:
         wordsiv: api-reference.md

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,6 +29,12 @@ pytest = "^8.3.4"
 pytest-cov = "^6.0.0"
 pre-commit = "^4.0.1"
 
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.6.1"
+mkdocstrings = "^0.27.0"
+mkdocstrings-python = "^1.13.0"
+mkdocs-material = "^9.5.49"
+
 [tool.poe.tasks]
 test = "poetry run python -m pytest"
 coverage = "poetry run pytest --cov-report term-missing --cov=wordsiv tests/ --ignore=tests/test_snippets.py"