search

Seluj78 / flask-utils

Various Flask utilities that I find useful in my projects
GNU General Public License v3.0
2 stars 1 forks source link

Hide full links in docs #29

Closed Mews closed 3 months ago

Mews commented 3 months ago

Description

Modified the sphinx config file to not include full paths when building the docs

Related Issue

Checklist

Type of change

📚 Documentation preview 📚: https://flask-utils--29.org.readthedocs.build/en/29/

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

This update refines the documentation and codebase of a Flask application by replacing full path references with relative paths for better readability. It includes changes to the api.rst, conf.py, decorators.py, and errors/__init__.py files, focusing on simplifying exception handling and documentation references.

Changes

Files/Paths Change Summaries
docs/source/api.rst Updated documentation to use FlaskUtils class methods directly for error handling setup.
docs/source/conf.py Added add_module_names = False configuration for EPUB output.
flask_utils/decorators.py Changed docstring in validate_params to raise BadRequestError instead of full path reference.
flask_utils/errors/__init__.py Updated references to FlaskUtils class and methods to use relative paths with ~ symbol.

Assessment against linked issues

Objective (Issue #10) Addressed Explanation
Refactor documentation to avoid full links ✅

Poem

In the world of Flask, a change so bright, Simplifying paths, making docs light. FlaskUtils now stands clear and tall, With shorter links, we heed the call. A rabbit hops, in joy it sings, For clarity, these updates bring.

[!WARNING]

Review ran into problems

Problems (1) * Git: Failed to clone repository. Please contact CodeRabbit support.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Seluj78 commented 3 months ago

Oh wow I didn't think it would be that easy, nice one ! 🙌

I have found some full links still, they might be due to me hard-coding them, but here are the links to the preview build of your PR where I found them, ideally if you could fix those as well in the same PR it would be amazing !

https://flask-utils--29.org.readthedocs.build/en/29/api.html#custom-exceptions

https://flask-utils--29.org.readthedocs.build/en/29/api.html#module-flask_utils.decorators

https://flask-utils--29.org.readthedocs.build/en/29/api.html#flask_utils.errors._register_error_handlers

Mews commented 3 months ago

Oops yeah I didn't realise that, I fixed that now

Mews commented 3 months ago

Is it? I counted 69 characters but I'll shorten it

Seluj78 commented 3 months ago

Also sphinx-lint detected some trailing whitespaces

Mews commented 3 months ago

Oh mb where are they, I can't see the logs

Seluj78 commented 3 months ago

Oh mb where are they, I can't see the logs

No worries haha, that's why I recommend you install pre-commit like explained in CONTRIBUTING.md Screenshot 2024-06-12 at 11 36 31

Screenshot 2024-06-12 at 11 36 39

Mews commented 3 months ago

I had it installed but I cleared my venv and I forgot :/ I'll fix it now

Seluj78 commented 3 months ago

Don't forget to do pre-commit install and then pre-commit install --hook-type commit-msg

Mews commented 3 months ago

Done!

Seluj78 commented 3 months ago

Weirdly, your commit still isn't passing. Do you want to try again or do you want me to do it ?

Mews commented 3 months ago

The commit message? Which one is failing I can change it again

Seluj78 commented 3 months ago

This one weirdly

Screenshot 2024-06-12 at 11 50 36

Mews commented 3 months ago

Mhm that's definitely less than 72 characters image

Seluj78 commented 3 months ago

Want me to try ? Don't touch your branch I'll try and fix it if you're ok with it

Mews commented 3 months ago

Okay 👍

Seluj78 commented 3 months ago

Hmm still trying to figure it out

Seluj78 commented 3 months ago

Here I fixed it by force. I removed the 72 chars limit. It's dumb anyway, and that way I will enforce it manually, or switch to using a better commit format (see #31)

Seluj78 commented 3 months ago

Thank you for the PR @Mews ! 😍