Release 3.2.4

What's new

This release primarily focuses on significant documentation enhancements, crucial bug fixes for stability and build processes, and introduces updated dependencies and tokenization.

✨ New Features

• Upgraded default token estimation to use gpt-4o-mini tokenizer, replacing gpt-3.5-turbo ([6d41817]).
• Integrated the latest yt-dlp for YouTube downloads ([ab207b4]).
• Environment variable documentation is now automatically added to the EnvDataclass class __doc__ ([ed9dd38]).

🐛 Bug Fixes

• Resolved a crash on ReadTheDocs caused by missing yt-dlp dependency ([f5068a3]).
• Fixed an issue where accessing env.__class__ on ReadTheDocs could cause a crash ([4e180f0]).
• Corrected relative import paths in wdoc that were preventing Sphinx API documentation builds ([ade5930]).
• Fixed issues with the Sphinx API command in the FAQ section of the README ([38008aa], [ff093a2]).
• Ensured collapsible bars in documentation function correctly ([3cef833]).

📚 Documentation & Refinements

• Extensive updates and fixes to Sphinx documentation generation and content:
  • Addressed outdated Sphinx documentation files ([90bde99]).
  • Improved API autodoc parameters for clearer documentation ([243de66]).
  • Excluded private and special members from documentation ([7abedd4]).
  • Added Sphinx command to FAQ in README ([1e6602e]) and removed private members from it ([11ae11b]).
  • Updated copyright year to 2025 ([bd7e3c5]).
• Streamlined documentation structure and configuration:
  • Removed unused make files (Makefile, make.bat) for documentation ([07b0a7d]).
  • Removed unused argument for theme flyout display ([17bc5e6]).
  • Removed unused templates path ([6bffa20]) and CSS ([712df08]).
  • Removed duplicate README from the documentation source ([2b93162]).
  • Added a documentation table to the main index ([1dfe2b3]).

⚙️ Build & Chores

• Bumped version to 3.2.4 ([ed7a9c7]).

Commits details since the last release

• [ed7a9c7] by @thiswillbeyourgithub, 20 seconds ago:
  bump version 3.2.3 -> 3.2.4

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

• [f5068a3] by @thiswillbeyourgithub, 13 minutes ago:
  fix: missing yt-dlp makes readthedock crash
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

setup.py

• [17bc5e6] by @thiswillbeyourgithub, 19 minutes ago:
  remove unused argument for theme flyout display
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [4e180f0] by @thiswillbeyourgithub, 22 minutes ago:
  fix: class attribute of env is accessed by readthedocks and should not crash
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/utils/env.py

• [243de66] by @thiswillbeyourgithub, 2 hours ago:
  saner api autodoc parameters
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [ed9dd38] by @thiswillbeyourgithub, 3 hours ago:
  new: add the environment variable documentation to the doc of the EnvDataclass class
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/docs/help.md
wdoc/utils/env.py

• [07b0a7d] by @thiswillbeyourgithub, 3 hours ago:
  doc: remove unused make files for doc
  Signed-off-by: thiswillbeyourgithub
  26625900+thiswillbeyourgithub@users.noreply.github.com

docs/Makefile
docs/make.bat

• [7abedd4] by @thiswillbeyourgithub, 4 hours ago:
  doc: dont include private nor special
  Signed-off-by: thiswillbeyourgithub
  26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [38008aa] by @thiswillbeyourgithub, 2 hours ago:
  fix: sphinx api command of faq
  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

README.md

• [11ae11b] by @thiswillbeyourgithub, 4 hours ago:
  remove private from sphinx command
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md

• [90bde99] by @thiswillbeyourgithub, 4 hours ago:
  fix outdated sphinx doc
  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

• [ff093a2] by @thiswillbeyourgithub, 4 hours ago:
  fix: sphinx api command of faq
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md

• [ade5930] by @thiswillbeyourgithub, 4 hours ago:
  fix: relative wdoc imports were stopping sphinx api build
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/init.py
wdoc/main.py
wdoc/utils/init.py
wdoc/utils/batch_file_loader.py
wdoc/utils/customs/init.py
wdoc/utils/embeddings.py
wdoc/utils/env.py
wdoc/utils/import_tricks.py
wdoc/utils/interact.py
wdoc/utils/llm.py
wdoc/utils/loaders.py
wdoc/utils/logger.py
wdoc/utils/misc.py
wdoc/utils/prompts.py
wdoc/utils/retrievers.py
wdoc/utils/tasks/init.py
wdoc/utils/tasks/query.py
wdoc/utils/tasks/summarize.py
wdoc/utils/typechecker.py
wdoc/wdoc.py

• [1e6602e] by @thiswillbeyourgithub, 5 hours ago:
  doc: add to faq the sphinx command
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

README.md

• [bd7e3c5] by @thiswillbeyourgithub, 5 hours ago:
  update copyright year to 2025
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [6bffa20] by @thiswillbeyourgithub, 6 hours ago:
  remove unused templates path in doc
  Signed-off-by: thiswillbeyourgithub
  26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [2b93162] by @thiswillbeyourgithub, 6 hours ago:
  remove duplicate readme from the doc
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/index.rst

• [3cef833] by @thiswillbeyourgithub, 6 hours ago:
  fix collapsible bar
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/conf.py

• [712df08] by @thiswillbeyourgithub, 6 hours ago:
  remove unused css from the doc
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

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

• [1dfe2b3] by @thiswillbeyourgithub, 6 hours ago:
  documentation table
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

docs/source/index.rst

• [6d41817] by @thiswillbeyourgithub, 25 hours ago:
  new: use gpt-4o-mini tokenizer by default to estimate tokens
  previously we used the ageing gpt-3.5-turbo

Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/docs/help.md
wdoc/utils/misc.py

• [ab207b4] by @thiswillbeyourgithub, 25 hours ago:
  new: use the latest yt-dl install from yt-dlp
  Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

setup.py