Skip to content

docs: correct API reference config and escape docstring links#9996

Merged
dfokina merged 2 commits into
mainfrom
fix-docusaurus-pydocs
Oct 31, 2025
Merged

docs: correct API reference config and escape docstring links#9996
dfokina merged 2 commits into
mainfrom
fix-docusaurus-pydocs

Conversation

@dfokina

@dfokina dfokina commented Oct 31, 2025

Copy link
Copy Markdown
Contributor

Proposed Changes:

  • Fix pydoc configs for data_classes.yml (had a typo with double s) and extractors.yml (docusaurus_config used Readme renderer that caused 2.20 version of extractors api reference to not have the correct frontmatter)
  • Escape the [text](address) example in docx.py docstring

Notes for the reviewer

After this is merged, I'll check the Vercel deployment success in #9993 and see if errors were properly fixed

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
  • I added unit tests and updated the docstrings
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@vercel

vercel Bot commented Oct 31, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
haystack-docs Ignored Ignored Preview Oct 31, 2025 0:25am

@github-actions github-actions Bot added the type:documentation Improvements on the docs label Oct 31, 2025
@dfokina dfokina added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Oct 31, 2025
@coveralls

coveralls commented Oct 31, 2025

Copy link
Copy Markdown
Collaborator

Pull Request Test Coverage Report for Build 18972466605

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.02%) to 92.244%

Totals Coverage Status
Change from base Build 18971464217: 0.02%
Covered Lines: 13498
Relevant Lines: 14633

💛 - Coveralls

@dfokina dfokina requested a review from anakin87 October 31, 2025 12:28
@dfokina dfokina marked this pull request as ready for review October 31, 2025 12:28
@dfokina dfokina requested a review from a team as a code owner October 31, 2025 12:28
@dfokina dfokina merged commit b10c2c1 into main Oct 31, 2025
31 of 32 checks passed
@dfokina dfokina deleted the fix-docusaurus-pydocs branch October 31, 2025 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ignore-for-release-notes PRs with this flag won't be included in the release notes. type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants