[dodu94]

Description

Add a new zensical documenation. Much more detailed and organized

Summary by CodeRabbit

• New Features

  • Added a documentation site with installation and getting-started guides, API references, user guides, and notebook-based examples.
  • Added automatic documentation builds and publishing to GitHub Pages.

• Bug Fixes

  • Radius-based searches now prioritize the closest neighboring points, improving interpolation when a source point is coincident with a destination.

• Documentation

  • Updated the README with a concise library overview and links to the online documentation.

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: ab55cf40-c6e8-42c5-81e2-0af14baa11ce

📥 Commits

Reviewing files that changed from the base of the PR and between af185e1 and d390dfb.

⛔ Files ignored due to path filters (3)

• docs/assets/img/fem_kernel.svg is excluded by !**/*.svg
• docs/assets/img/philosophies.svg is excluded by !**/*.svg
• docs/assets/img/query_methods.svg is excluded by !**/*.svg

📒 Files selected for processing (40)

• .github/workflows/docs.yml
• .gitignore
• README.md
• docs/api/config.md
• docs/api/dest_tree.md
• docs/api/errors.md
• docs/api/interpolator.md
• docs/api/kernels.md
• docs/api/parsers.md
• docs/examples/em_force/destination_mesh.txt
• docs/examples/em_force/em_force.ipynb
• docs/examples/em_force/source_data/em_force_data.txt
• docs/examples/heat_flux/destination_mesh.txt
• docs/examples/heat_flux/heat_flux.ipynb
• docs/examples/heat_flux/source_data/heat_flux_data.txt
• docs/examples/heat_flux/source_mesh.txt
• docs/examples/heat_gen/destination_mesh.txt
• docs/examples/heat_gen/heat_gen.ipynb
• docs/examples/heat_gen/source_data/heat_gen_data.txt
• docs/examples/htc/destination_mesh.txt
• docs/examples/htc/htc.ipynb
• docs/examples/htc/source_data/htc_data.txt
• docs/examples/index.md
• docs/getting-started.md
• docs/index.md
• docs/installation.md
• docs/javascripts/katex.js
• docs/stylesheets/extra.css
• docs/user-guide/analysis.md
• docs/user-guide/configuration.md
• docs/user-guide/file-formats.md
• docs/user-guide/how-it-works.md
• docs/user-guide/kernels.md
• docs/user-guide/load-types.md
• docs/user-guide/query-methods.md
• pyproject.toml
• src/interpcore/dest_tree.py
• src/interpcore/interpolator.py
• tests/test_kernels.py
• zensical.toml

 _______________________________________________________________
< Your null checks are like seatbelts: installed, but not worn. >
 ---------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}