Skip to content

fix(python): make document inclusion in docs allow relative paths. #395

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

Merged
merged 22 commits into from
May 2, 2025

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Apr 22, 2025

Description

Allows us to include documentation by a relative path for simpler management of related information.
Also makes sure all python code is properly formatted and linted and corrects any linting issues.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@stevenj stevenj self-assigned this Apr 22, 2025
@stevenj stevenj removed this from Catalyst Apr 22, 2025
@stevenj stevenj added documentation Pull requests that update a documentation ci/cd CI/CD Fixes or Improvements. do not merge yet PR is not ready to be merged yet do not review yet Do not review yet labels Apr 22, 2025
@stevenj stevenj removed do not merge yet PR is not ready to be merged yet do not review yet Do not review yet labels May 2, 2025
@stevenj stevenj requested a review from Mr-Leshiy May 2, 2025 02:39
@stevenj stevenj moved this from New to 👀 In review in Catalyst May 2, 2025
@stevenj stevenj requested a review from bkioshn May 2, 2025 02:40
Copy link
Contributor

@Mr-Leshiy Mr-Leshiy left a comment

Choose a reason for hiding this comment

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

LGTM

@stevenj stevenj merged commit 91fc23f into master May 2, 2025
37 checks passed
@stevenj stevenj deleted the feat/include-relative-docs branch May 2, 2025 04:04
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Catalyst May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd CI/CD Fixes or Improvements. documentation Pull requests that update a documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants