Feature/25 integrate notebooks into docu

MarcoHuebner commented 2 months ago

update conf, index and deployment workflow to add notebooks to docu
update dependencies
adapt pre-commit hook: Remove step local documentation building

Addresses #25

Summary by CodeRabbit

Release Notes

New Features
- Enhanced documentation deployment process with the addition of Pandoc installation and improved notebook integration.
- Added support for Jupyter Notebooks in documentation through the nbsphinx extension.
Documentation
- Updated README to clarify prerequisites for building documentation locally.
- Introduced a new table of contents for notebooks in the documentation index for better navigation.
Bug Fixes
- Improved formatting and readability in the Geo-Visualization Example Notebook.

coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes primarily enhance the documentation deployment process by updating the workflow configuration, removing outdated pre-commit hooks, and modifying documentation files. Key updates include the installation of Pandoc, integration of Jupyter Notebooks via the nbsphinx extension, and improved organization of the documentation index. Additionally, formatting updates were made to a specific notebook to enhance readability. A new dependency for nbsphinx was also added to the project configuration.

Changes

File	Change Summary
`.github/workflows/deploy-docs.yaml`	Added steps to install Pandoc, clear existing notebook directory, and copy new notebook files for documentation deployment.
`.pre-commit-config.yaml`	Removed the `build-docs` hook related to Sphinx documentation compilation.
`README.md`	Updated instructions for local documentation build to include Pandoc installation prerequisites.
`docs/source/conf.py`	Added `nbsphinx` extension and set `nbsphinx_execute` option to "never" to control notebook execution during builds.
`docs/source/index.rst`	Introduced a new section with a table of contents for notebooks to enhance documentation organization.
`nb/02_Geo_visualization_example.ipynb`	Reformatted markdown cells for improved readability; no changes to code or functionality.
`pyproject.toml`	Added `nbsphinx` dependency with version `^0.9.5` to support Jupyter Notebooks in documentation.

Poem

🐰 In the garden of code, we hop and play,
With Pandoc and notebooks, we brighten the day.
Our docs now are tidy, with nbsphinx in tow,
A leap into clarity, watch our knowledge grow!
So gather 'round, friends, let’s share and delight,
In the world of our project, everything feels right! 🌼

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 , please review it.` -- `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 81.30%. Comparing base (1dcd903) to head (3912f89). Report is 1 commits behind head on dev.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## dev #149 +/- ## ======================================= Coverage 81.30% 81.30% ======================================= Files 11 11 Lines 551 551 ======================================= Hits 448 448 Misses 103 103 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

pmayd commented 2 months ago

@coderabbitai full review

coderabbitai[bot] commented 2 months ago

Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] commented 2 months ago

Actions performed

Full review triggered.

MarcoHuebner commented 2 months ago

Built documentation can be found at https://correlaid.github.io/pystatis/dev/index.html

CorrelAid / pystatis