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

Remove Napoleon from the documentation configuration. #2629

Merged
merged 2 commits into from
Jun 10, 2024

Conversation

freakboy3742
Copy link
Member

@freakboy3742 freakboy3742 commented Jun 9, 2024

A historical hangover - we no longer support NumPy/Google docstring format, so we can remove the Napoleon configuration.

We can also remove the sphinx-autodoc-typehints package as a dependency, as we're not using it any more.

Stemmed from this discussion

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

Copy link
Member

@rmartin16 rmartin16 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@freakboy3742 freakboy3742 merged commit 76efbba into beeware:main Jun 10, 2024
31 of 34 checks passed
@freakboy3742 freakboy3742 deleted the dethrone-napoleon branch June 10, 2024 00:46
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.

2 participants