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

DOC: hide audb.config.__eq__() docstring #476

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Dec 4, 2024

Hide audb.config.__eq__() from the API documentation.

This is achieved by customizing the class.rst template from sphinx-apipages to skip methods for a class named config.

Summary by Sourcery

Documentation:

  • Hide the audb.config.eq() method from the API documentation by customizing the class.rst template.

Copy link
Contributor

sourcery-ai bot commented Dec 4, 2024

Reviewer's Guide by Sourcery

The PR customizes Sphinx documentation configuration to hide a specific method (__eq__) from the API documentation of the config class. This is implemented by adding a custom template path and creating a new template file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Configure Sphinx to use custom templates
  • Add templates_path configuration to specify custom template directory
  • Create new directory for custom templates
docs/conf.py
docs/_templates/autosummary/class.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @hagenw - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Could you share the content of the new template file docs/_templates/autosummary/class.rst? This would help verify the template is correctly configured to only hide the intended method.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@hagenw hagenw merged commit bd1dcd6 into main Dec 4, 2024
8 checks passed
@hagenw hagenw deleted the extend-config-eq-doc branch December 4, 2024 09:45
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.

1 participant