Skip to content

Document the :autolink: role #1535

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.

Sign up for GitHub

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

Jump to bottom
Closed
shimizukawa opened this issue Jan 3, 2015 · 1 comment · Fixed by #13596
Closed

Document the :autolink: role #1535

shimizukawa opened this issue Jan 3, 2015 · 1 comment · Fixed by #13596
Labels
easy issue that can be solved by beginners good first issue help wanted type:docs
Milestone
some future version

Comments

@shimizukawa
Copy link
Member

I can not find any documentation of the autolink role in the built html documentation, but it used to be there (http://code.nabla.net/doc/sphinx/api/sphinx/ext/sphinx.ext.autosummary.html )
@shimizukawa shimizukawa added this to the 1.4 milestone Jan 3, 2015
@shimizukawa shimizukawa added type:enhancement enhance or introduce a new feature type:docs type:proposal a feature suggestion labels Jan 3, 2015
@shimizukawa
Copy link
Member Author

From Takayuki Shimizukawa on 2014-08-18 01:57:46+00:00

Thanks for the reporting.

The autosummary code has been brought from numpy at the commit: 69f7b5dd0d15 and the docstring has never been appeared on the Sphinx official document page.

We will check the :autolink: role feature and we should update document and/or code properly.

@tk0miya tk0miya removed this from the 1.4 milestone Feb 14, 2016
@AA-Turner AA-Turner added this to the some future version milestone Sep 29, 2022
@AA-Turner AA-Turner added help wanted good first issue easy issue that can be solved by beginners and removed type:enhancement enhance or introduce a new feature type:proposal a feature suggestion labels Jan 8, 2025
@AA-Turner AA-Turner changed the title autolink role is not documented in the html docs Document the :autolink: role Jan 8, 2025
@melissawm melissawm mentioned this issue May 27, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
easy issue that can be solved by beginners good first issue help wanted type:docs
Projects
None yet
Milestone
some future version
Development

Successfully merging a pull request may close this issue.

Document autolink role for autosummary melissawm/sphinx
3 participants
@shimizukawa @tk0miya @AA-Turner