add api-path to project configuration

[dustinlagoy]

First, thanks for this very helpful MkDocs plugin!

We have been using it for including our C++ code documentation which has been working well but is missing a useful feature. We generally put auto-generated code documentation in a sub-path of our main documentation to keep it organized, but MkDoxy currently always uses the project name as the output path.

To enable customizing the output path I made api-path a MkDoxy configurable setting.

I am also using the src-dirs as part of the generated API path but that could be removed. Some other options that could work is instead of:

apiPath = os.path.join(
    project_data.get("api-path", "."), project_data.get("src-dirs")
)

are either:

apiPath = os.path.join(project_data.get("api-path", "."), project_name)

or:

apiPath = project_data.get("api-path", project_name)

and assume the user will put the full path for each project in the api-path configuration setting if they want to override the default.

Any of these would work for us. Is there any interest in merging this feature?

Summary by Sourcery

This pull request adds a new 'api-path' configuration setting to the MkDoxy plugin, enabling users to customize the output path for auto-generated code documentation. The API path generation logic has been enhanced to incorporate this new setting along with 'src-dirs' for improved documentation organization.

• New Features:
  • Introduced a new configurable setting 'api-path' in MkDoxy to allow customization of the output path for auto-generated code documentation.
• Enhancements:
  • Updated the API path generation logic to use the new 'api-path' setting combined with 'src-dirs' for better organization of generated documentation.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new configuration option 'api-path' to the MkDoxy plugin, allowing users to customize the output path for generated API documentation. The 'apiPath' assignment in the code has been updated to use this new setting along with 'src-dirs' from the project data.

File-Level Changes

Files	Changes
mkdoxy/plugin.py	Introduced a new configuration option 'api-path' to allow customization of the output path for generated API documentation. Updated the 'apiPath' assignment logic to incorporate this new setting.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

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

Overall Comments:

• The feature to customize the API output path is a good addition. However, consider simplifying the implementation by using apiPath = project_data.get("api-path", project_name). This approach provides flexibility for users while maintaining a clear default behavior.

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}