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

Fix #8004: napoleon_preprocess_types for Google style docstrings #8731

Merged
merged 1 commit into from
Jan 24, 2021

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jan 23, 2021

Feature or Bugfix

  • Feature

Purpose

…rings

Type definitions in Google style docstrings are rendered as references
when :confval:`napoleon_preprocess_types` enabled.
@tk0miya tk0miya force-pushed the 8004_preprocess_types_for_google branch from d3ac161 to 440e64a Compare January 23, 2021 05:20
@tk0miya tk0miya merged commit deda191 into sphinx-doc:3.x Jan 24, 2021
@tk0miya tk0miya deleted the 8004_preprocess_types_for_google branch January 24, 2021 04:59
@mondeja
Copy link
Contributor

mondeja commented Apr 10, 2021

Hello, I've a question related with this change. Shouldn't be documented in sphinx.ext.napoleon#Configuration? I've had to get to this pull through the issues to set up the documentation of a project correctly...

@tk0miya
Copy link
Member Author

tk0miya commented Apr 11, 2021

Oops! I've never know it's not documented... I'll do it soon.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
extensions:napoleon type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants