Skip to content

[pull] main from capitalone:main #44

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.

Sign up for GitHub

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

Jump to bottom
Merged
pull merged 2 commits into from
Mar 18, 2025
Merged

[pull] main from capitalone:main #44

pull merged 2 commits into from
Mar 18, 2025

Conversation

@pull
Copy link

@pull pull bot commented Mar 18, 2025 •
edited by sourcery-ai bot
Loading

See Commits and Changes for more details.

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

This PR introduces documentation updates and build system changes. It adds a new directory _docs containing documentation-related files, including Sphinx configuration, a script to update documentation, and instructions for updating the documentation. It also updates the pre-commit configuration to exclude the _docs directory from certain checks, and modifies the CI workflow to publish the docs on release.

Build:

  • Excludes the _docs directory from certain pre-commit checks.
  • Adds a new _docs directory with documentation-related files.
  • Updates the CI workflow to publish the docs on release.
  • Adds a makefile and batch file for building documentation.
  • Adds a setup.cfg file for flake8 and isort configuration in the _docs directory.
  • Adds requirements-docs.txt file for documentation dependencies.
  • Updates MANIFEST.in to include the _docs directory.

shania-m added 2 commits March 18, 2025 12:20
@shania-m
gh pages update (#1173)
ed8188a 
* chore: create publish-docs.yml

* brought in docs directory
@shania-m
Update gh-pages workflows (#1174)
09c2062 
* chore: update workflow to properly install pandoc
* chore: update build to build to a LATEST directory
@pull pull bot added the ⤵️ pull label Mar 18, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Mar 18, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces documentation generation capabilities using Sphinx. It adds necessary configuration files, scripts, and documentation source files. It also configures pre-commit hooks to exclude the _docs/ directory and introduces a workflow for automated documentation publishing.

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

File-Level Changes

Change Details Files
Excludes the _docs/ directory from various pre-commit hooks, such as black, isort, flake8, trailing-whitespace, end-of-file-fixer, mypy, pyupgrade, and autoflake.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from black.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from isort.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from flake8.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from trailing-whitespace.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from end-of-file-fixer.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from mypy.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from pyupgrade.
  • Update .pre-commit-config.yaml to exclude the _docs/ directory from autoflake.
 .pre-commit-config.yaml
Adds files and configurations for documentation generation using Sphinx.
  • Add _docs/docs/update_documentation.py to generate documentation from the current repo.
  • Add _docs/docs/source/conf.py to configure Sphinx.
  • Add _docs/README.md to provide instructions on writing and updating documentation.
  • Add _docs/docs/source/_static/custom.css to customize the look and feel of the generated documentation.
  • Add .github/workflows/publish-docs.yml to automate documentation publishing upon release.
  • Add _docs/docs/make.bat for Sphinx documentation.
  • Add _docs/docs/Makefile for Sphinx documentation.
  • Add _docs/setup.cfg to configure flake8 and isort.
  • Add _docs/index.html to redirect to the latest documentation version.
  • Add _docs/profiler_options.html to redirect to detailed options docs.
 _docs/docs/update_documentation.py
_docs/docs/source/conf.py
_docs/README.md
_docs/docs/source/_static/custom.css
.github/workflows/publish-docs.yml
_docs/docs/make.bat
_docs/docs/Makefile
_docs/setup.cfg
_docs/index.html
_docs/profiler_options.html
Adds documentation files.
  • Add _docs/docs/source/API.rst.
  • Add _docs/docs/source/add_new_model_to_data_labeler.nblink.
  • Add _docs/docs/source/column_name_labeler_example.nblink.
  • Add _docs/docs/source/data_labeling.rst.
  • Add _docs/docs/source/data_reader.nblink.
  • Add _docs/docs/source/data_readers.rst.
  • Add _docs/docs/source/examples.rst.
  • Add _docs/docs/source/graph_data_demo.nblink.
  • Add _docs/docs/source/graphs.rst.
  • Add _docs/docs/source/index.rst.
  • Add _docs/docs/source/install.rst.
  • Add _docs/docs/source/labeler.nblink.
  • Add _docs/docs/source/merge_profile_list.nblink.
  • Add _docs/docs/source/modules.rst.
  • Add _docs/docs/source/overview.nblink.
  • Add _docs/docs/source/popmon_dp_loader_example.nblink.
  • Add _docs/docs/source/profiler.rst.
  • Add _docs/docs/source/profiler_example.nblink.
  • Add _docs/docs/source/regex_labeler_from_scratch.nblink.
  • Add _docs/docs/source/roadmap.rst.
  • Add _docs/docs/source/unstructured_profiler_example.nblink.
 _docs/docs/source/API.rst
_docs/docs/source/add_new_model_to_data_labeler.nblink
_docs/docs/source/column_name_labeler_example.nblink
_docs/docs/source/data_labeling.rst
_docs/docs/source/data_reader.nblink
_docs/docs/source/data_readers.rst
_docs/docs/source/examples.rst
_docs/docs/source/graph_data_demo.nblink
_docs/docs/source/graphs.rst
_docs/docs/source/index.rst
_docs/docs/source/install.rst
_docs/docs/source/labeler.nblink
_docs/docs/source/merge_profile_list.nblink
_docs/docs/source/modules.rst
_docs/docs/source/overview.nblink
_docs/docs/source/popmon_dp_loader_example.nblink
_docs/docs/source/profiler.rst
_docs/docs/source/profiler_example.nblink
_docs/docs/source/regex_labeler_from_scratch.nblink
_docs/docs/source/roadmap.rst
_docs/docs/source/unstructured_profiler_example.nblink
Adds requirements-docs.txt to specify documentation dependencies.
  • Add requirements-docs.txt.
 requirements-docs.txt
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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@pull pull bot merged commit 09c2062 into admariner:main Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

⤵️ pull

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shania-m