Release 2.5.0

What's new

• full code is available on readthedocs too
• added pre commits push, better tests
• minor enhancements

Commits details since the last release

• [791967a] by @thiswillbeyourgithub, 72 seconds ago:
  bump version 2.4.16 -> 2.5.0

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

• [dfee2aa] by @thiswillbeyourgithub, 6 minutes ago:
  fix toc
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [5e68159] by @thiswillbeyourgithub, 9 minutes ago:
  fix toc
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [d8c19ac] by @thiswillbeyourgithub, 11 minutes ago:
  fix toc
  Signed-off-by: thiswillbeyourgithub
  26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [463ff08] by @thiswillbeyourgithub, 13 minutes ago:
  fix api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [153c31f] by @thiswillbeyourgithub, 21 minutes ago:
  update all docs
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/wdoc.rst
docs/source/wdoc.utils.batch_file_loader.rst
docs/source/wdoc.utils.customs.compressed_embeddings_cache.rst
docs/source/wdoc.utils.customs.fix_llm_caching.rst
docs/source/wdoc.utils.customs.rst
docs/source/wdoc.utils.embeddings.rst
docs/source/wdoc.utils.env.rst
docs/source/wdoc.utils.errors.rst
docs/source/wdoc.utils.flags.rst
docs/source/wdoc.utils.import_tricks.rst
docs/source/wdoc.utils.interact.rst
docs/source/wdoc.utils.llm.rst
docs/source/wdoc.utils.loaders.rst
docs/source/wdoc.utils.logger.rst
docs/source/wdoc.utils.misc.rst
docs/source/wdoc.utils.prompts.rst
docs/source/wdoc.utils.retrievers.rst
docs/source/wdoc.utils.rst
docs/source/wdoc.utils.tasks.query.rst
docs/source/wdoc.utils.tasks.rst
docs/source/wdoc.utils.tasks.summarize.rst
docs/source/wdoc.utils.typechecker.rst
docs/source/wdoc.wdoc.rst

• [9e33f3c] by @thiswillbeyourgithub, 21 minutes ago:
  update api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [021b192] by @thiswillbeyourgithub, 25 minutes ago:
  fix: only add each python object once
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [253967b] by @thiswillbeyourgithub, 34 minutes ago:
  update api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [6911dfd] by @thiswillbeyourgithub (aider), 49 minutes ago:
  docs: Fix RST header formatting for table of contents

docs/source/api.rst

• [3d4c6f8] by @thiswillbeyourgithub, 53 minutes ago:
  docs: include api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/index.rst
docs/source/usage.rst

• [0b944e0] by @thiswillbeyourgithub, 53 minutes ago:
  remove autogen stuff
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/_autogen/wdoc.rst
docs/source/_autogen/wdoc.utils.customs.rst
docs/source/_autogen/wdoc.utils.rst
docs/source/_autogen/wdoc.utils.tasks.rst

• [5a85a87] by @thiswillbeyourgithub, 60 minutes ago:
  fix: usage
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/index.rst
docs/source/usage.rst
docs/source/usage_link.md

• [bd40e1b] by @thiswillbeyourgithub, 66 minutes ago:
  docs: update
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/index.rst
docs/source/usage.rst

• [10b7055] by @thiswillbeyourgithub, 76 minutes ago:
  docs: try to rollback the docstring
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst
docs/source/conf.py

• [bf06707] by @thiswillbeyourgithub, 84 minutes ago:
  docs: fix missing docstring
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/requirements.txt

• [9f4ea1c] by @thiswillbeyourgithub, 84 minutes ago:
  docs
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [42aae74] by @thiswillbeyourgithub, 2 hours ago:
  docs: fix api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/_autogen/wdoc.rst
docs/source/_autogen/wdoc.utils.customs.rst
docs/source/_autogen/wdoc.utils.rst
docs/source/_autogen/wdoc.utils.tasks.rst
docs/source/api.rst
docs/source/conf.py

• [1a9e8d7] by @thiswillbeyourgithub, 2 hours ago:
  reduce max depth of index
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/index.rst

• [54b5242] by @thiswillbeyourgithub, 2 hours ago:
  docs: try to fix docstrings missing from rtd
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [f463746] by @thiswillbeyourgithub, 2 hours ago:
  docs: dont put all the files in the doc index
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/index.rst

• [b5cc254] by @thiswillbeyourgithub, 2 hours ago:
  docs: add table of content to api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [35bd030] by @thiswillbeyourgithub, 2 hours ago:
  fix: dont include api from objects that are not part of wdoc in the api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [2198a7a] by @thiswillbeyourgithub, 2 hours ago:
  update docs
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/wdoc.rst
docs/source/wdoc.utils.customs.rst
docs/source/wdoc.utils.rst
docs/source/wdoc.utils.tasks.rst

• [3de89de] by @thiswillbeyourgithub, 2 hours ago:
  docs: remove diy broken files
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/_ext/better_docstring.py
docs/source/_ext/raw_docstring.py
docs/source/conf.py

• [84facad] by @thiswillbeyourgithub, 3 hours ago:
  docs: better css
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/_static/custom.css
docs/source/conf.py

• [ab97e53] by @thiswillbeyourgithub, 3 hours ago:
  fix: rtd only supports python 3.11 version
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

.readthedocs.yaml

• [b5d5cc5] by @thiswillbeyourgithub, 3 hours ago:
  fix: set python version of rtd to 3.11.7
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

.readthedocs.yaml

• [b6074f6] by @thiswillbeyourgithub, 3 hours ago:
  fix: docs docstrings
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [55dc7b7] by @thiswillbeyourgithub, 3 hours ago:
  docs: explain how to bypass chunking for queries
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md
wdoc/docs/USAGE.md

• [d4eb997] by @thiswillbeyourgithub, 3 hours ago:
  docs: update api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/wdoc.rst
docs/source/wdoc.utils.batch_file_loader.rst
docs/source/wdoc.utils.customs.compressed_embeddings_cache.rst
docs/source/wdoc.utils.customs.fix_llm_caching.rst
docs/source/wdoc.utils.customs.rst
docs/source/wdoc.utils.embeddings.rst
docs/source/wdoc.utils.env.rst
docs/source/wdoc.utils.errors.rst
docs/source/wdoc.utils.flags.rst
docs/source/wdoc.utils.import_tricks.rst
docs/source/wdoc.utils.interact.rst
docs/source/wdoc.utils.llm.rst
docs/source/wdoc.utils.loaders.rst
docs/source/wdoc.utils.logger.rst
docs/source/wdoc.utils.misc.rst
docs/source/wdoc.utils.prompts.rst
docs/source/wdoc.utils.retrievers.rst
docs/source/wdoc.utils.rst
docs/source/wdoc.utils.tasks.query.rst
docs/source/wdoc.utils.tasks.rst
docs/source/wdoc.utils.tasks.summarize.rst
docs/source/wdoc.utils.typechecker.rst
docs/source/wdoc.wdoc.rst

• [5888e2b] by @thiswillbeyourgithub, 4 hours ago:
  fix: the ntfy topic has to be specified twice in case of error
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

scripts/NtfySummarizer/script.sh

• [4f3a902] by @thiswillbeyourgithub, 4 hours ago:
  better error message
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

scripts/NtfySummarizer/script.sh

• [25d7f8e] by @thiswillbeyourgithub, 4 hours ago:
  fix: cd into wdoc just in case there are some autoenv things to execute
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

scripts/NtfySummarizer/script.sh

• [126c068] by @thiswillbeyourgithub, 4 hours ago:
  docs: add comment explaining why we try to load the shell profiles
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

scripts/NtfySummarizer/script.sh

• [ab5a8c5] by @thiswillbeyourgithub, 4 hours ago:
  docs: explain which hoops to jump through to get ntfy to work
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

scripts/NtfySummarizer/README.md

• [9798f87] by @thiswillbeyourgithub, 4 hours ago:
  new: send the error message through ntfy if needed
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

scripts/NtfySummarizer/script.sh

• [51d9e54] by @thiswillbeyourgithub, 8 hours ago:
  scripts: update topics example
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

scripts/NtfySummarizer/TOPICS.EXAMPLE

• [2f7aa99] by @thiswillbeyourgithub (aider), 23 hours ago:
  docs: Update Sphinx configuration to improve docstring generation and module documentation

docs/source/api.rst
docs/source/conf.py

• [4d6e16f] by @thiswillbeyourgithub (aider), 23 hours ago:
  docs: Improve docstring formatting and add Sphinx processing extensions

docs/source/_ext/better_docstring.py
docs/source/conf.py
wdoc/utils/interact.py

• [56e9a5a] by @thiswillbeyourgithub (aider), 24 hours ago:
  docs: Improve docstring handling and API documentation structure

docs/source/_ext/raw_docstring.py
docs/source/api.rst

• [713ffde] by @thiswillbeyourgithub, 24 hours ago:
  docs: try to fix api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst

• [daeea16] by @thiswillbeyourgithub, 24 hours ago:
  docs: test new display
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [0fcf78f] by @thiswillbeyourgithub (aider), 25 hours ago:
  docs: Update Sphinx configuration to improve API documentation generation

docs/source/api.rst
docs/source/conf.py

• [7283e85] by @thiswillbeyourgithub, 25 hours ago:
  docs: update api
  Signed-off-by: thiswillbeyourgithub
  26625900+thiswillbeyourgithub@users.noreply.github.com
  Signed-off-by: thiswillbeyourgithub
  26625900+thiswillbeyourgithub@users.noreply.github.com
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/wdoc.rst
docs/source/wdoc.utils.customs.rst
docs/source/wdoc.utils.rst
docs/source/wdoc.utils.tasks.rst

• [ff70180] by @thiswillbeyourgithub, 25 hours ago:
  docs: update api
  Signed-off-by: thiswillbeyourgithub
  26625900+thiswillbeyourgithub@users.noreply.github.com
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py
docs/source/index.rst

• [4f1b26d] by @thiswillbeyourgithub, 25 hours ago:
  docs: update api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/wdoc.rst
docs/source/wdoc.utils.batch_file_loader.rst
docs/source/wdoc.utils.customs.compressed_embeddings_cache.rst
docs/source/wdoc.utils.customs.fix_llm_caching.rst
docs/source/wdoc.utils.customs.rst
docs/source/wdoc.utils.embeddings.rst
docs/source/wdoc.utils.env.rst
docs/source/wdoc.utils.errors.rst
docs/source/wdoc.utils.flags.rst
docs/source/wdoc.utils.import_tricks.rst
docs/source/wdoc.utils.interact.rst
docs/source/wdoc.utils.llm.rst
docs/source/wdoc.utils.loaders.rst
docs/source/wdoc.utils.logger.rst
docs/source/wdoc.utils.misc.rst
docs/source/wdoc.utils.prompts.rst
docs/source/wdoc.utils.retrievers.rst
docs/source/wdoc.utils.rst
docs/source/wdoc.utils.tasks.query.rst
docs/source/wdoc.utils.tasks.rst
docs/source/wdoc.utils.tasks.summarize.rst
docs/source/wdoc.utils.typechecker.rst
docs/source/wdoc.wdoc.rst

• [0e43214] by @thiswillbeyourgithub, 26 hours ago:
  ignore
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

.gitignore

• [b18c6d7] by @thiswillbeyourgithub, 26 hours ago:
  docs: update api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/_ext/raw_docstring.py
docs/source/conf.py

• [7622f47] by @thiswillbeyourgithub, 26 hours ago:
  docs: update api
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst
docs/source/conf.py

• [4a94d68] by @thiswillbeyourgithub, 26 hours ago:
  docs: use sphinx to generate the api docs
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/modules.rst
docs/source/wdoc.rst
docs/source/wdoc.utils.customs.rst
docs/source/wdoc.utils.rst
docs/source/wdoc.utils.tasks.rst

• [5287d00] by @thiswillbeyourgithub, 26 hours ago:
  todo
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md

• [f86745e] by @thiswillbeyourgithub, 26 hours ago:
  docs: try to add api to readthedocs
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/api.rst
docs/source/index.rst

• [5ed3d49] by @thiswillbeyourgithub, 26 hours ago:
  test: added test for query
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

tests/test_wdoc.py

• [5822cd4] by @thiswillbeyourgithub, 26 hours ago:
  fix: test of summary
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

tests/test_wdoc.py

• [37b9809] by @thiswillbeyourgithub, 26 hours ago:
  docs: better explanation about tests
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md

• [df2f783] by @thiswillbeyourgithub, 26 hours ago:
  add mark basic to some tests
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md
tests/test_wdoc.py

• [ff460d5] by @thiswillbeyourgithub, 27 hours ago:
  ignore test db
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

.gitignore

• [f7eeb77] by @thiswillbeyourgithub, 27 hours ago:
  better args for tests
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

tests/test_wdoc.py

• [d5cd48f] by @thiswillbeyourgithub, 29 hours ago:
  fix: test should not always include api calls
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

tests/test_wdoc.py

• [dd151f4] by @thiswillbeyourgithub, 29 hours ago:
  fix: no need to deduplicate documents if only one doc
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/utils/batch_file_loader.py

• [83e183d] by @thiswillbeyourgithub, 2 days ago:
  todo
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md

• [6dac599] by @thiswillbeyourgithub (aider), 2 days ago:
  test: Add test for YouTube video summary feature

tests/test_wdoc.py

• [96056e1] by @thiswillbeyourgithub, 2 days ago:
  fix: beartype import typing
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/utils/misc.py

• [77e2c78] by @thiswillbeyourgithub, 2 days ago:
  feat: add a env variable for the max chunk size
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/docs/USAGE.md
wdoc/utils/env.py
wdoc/utils/misc.py

• [9762281] by @thiswillbeyourgithub, 9 days ago:
  docs: add a todo
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md

• [cb09b8a] by @thiswillbeyourgithub, 9 days ago:
  tests: add pre commit push
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

.pre-commit-config.yaml