Skip to content

Add the sphinx-codeautolink extension to the doc build process? #134895

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

Open
cmarqu opened this issue May 29, 2025 · 0 comments
Open

Add the sphinx-codeautolink extension to the doc build process? #134895

cmarqu opened this issue May 29, 2025 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@cmarqu
Copy link

cmarqu commented May 29, 2025

I am proposing to include the https://github.com/felix-hilden/sphinx-codeautolink Sphinx extension into the documentation build process. This extension makes parseable Python code examples clickable so that it's easy to jump to the reference documentation of an object.

Related thread: https://discuss.python.org/t/add-the-sphinx-codeautolink-extension-to-doc-build-process/80814/11

A pull request to add the extension is upcoming.

Linked PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Status: Todo
Development

No branches or pull requests

1 participant