Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.2.1 #37

Merged
merged 4 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Binary file modified docs/images/wordsiv-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 0.2.1 – 2025-01-20

### Fixed

- minor docs/site issues

## 0.2.0 – 2025-01-20

### Added
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/sent.py
Original file line number Diff line number Diff line change
Expand Up @@ -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))
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading