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

Docs: Fix Sphinx 9 path warning #896

Closed
wants to merge 1 commit into from
Closed

Conversation

b8zhong
Copy link

@b8zhong b8zhong commented Mar 1, 2025

Fix the Sphinx9 warning for documentation building.

Appears to make the warning go away when building locally.

Fixes #830

  • I read the contribution guidelines

@cliffburdick
Copy link
Collaborator

/build

@cliffburdick
Copy link
Collaborator

Hi @b8zhong , it looks like the warning is still happening:

loading translations [en]... done
/usr/local/lib/python3.10/dist-packages/breathe/project.py:116: RemovedInSphinx90Warning: Sphinx 9 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead.
  self._default_build_dir = os.path.dirname(app.doctreedir.rstrip(os.sep))
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
building [mo]: targets for 0 po files that are out of date
writing output...

@cliffburdick
Copy link
Collaborator

/build

1 similar comment
@cliffburdick
Copy link
Collaborator

/build

@cliffburdick
Copy link
Collaborator

Hi @b8zhong , it looks like the Breathe and Sphinx version upgrade fixed this without any other changes. Just to reduce the amount of changes I will close this one, but thanks for looking into it!

@b8zhong
Copy link
Author

b8zhong commented Mar 2, 2025

Thanks for trying the builds! No problem, glad it went away.

@b8zhong b8zhong deleted the sphinx-build branch March 2, 2025 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix Sphinx9 deprecation when building documentation
2 participants