Skip to content

Corrected broken links to CONTRIBUTING.md file in README and document… #503

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

Merged
merged 1 commit into from
Nov 9, 2025
Merged

Corrected broken links to CONTRIBUTING.md file in README and document… #503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Changes - from version >= 1.x
* [docs] updated tutorials - new parameters are used in kriging operations, and when experimental variogram is computed
* [docs] added missing badges (Python version and package version)
* [docs] `CITATION.cff`, citation section in readme has been moved up, bibtex citation has been added
* [docs] corrected broken links to `CONTRIBUTING.md` file in readme and docs
* # todo [docs] docstring examples - all user-facing API endpoints has examples in docstrings, using new input types (values | geometries)

2025-10-11
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ A world of advice, you should **always** use Virtual Environment for the install

## Tests and contribution

All tests are grouped in the `test` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: [CONTRIBUTION.md](https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTION.md)
All tests are grouped in the `test` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: [CONTRIBUTING.md](https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTING.md)

## Use cases

Expand Down
Binary file modified docs/build/doctrees/contributor/development/tests_and_contribution.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/_sources/contributor/development/tests_and_contribution.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Tests and contribution
======================

All tests are grouped in the ``test`` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: `CONTRIBUTION.md <https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTION.md>`_
All tests are grouped in the ``test`` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: `CONTRIBUTING.md <https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTING.md>`_
10 changes: 5 additions & 5 deletions docs/build/html/_sources/index.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,18 @@ Pyinterpolate
-----------------

.. note::
The last documentation update: *2025-10-11*
The last documentation update: *2025-11-08*

Important notice
................

The package was updated to version 1.0 in June 2025. There are breaking API changes, so please, refer to the changelog, to know more about the changes.
Right now, the package in version 1.0.0 is in the **beta** stage, which means that it is stable but be careful with the production use. There might be some minor bugs, and large swaths of code are not optimized yet. If you find any bugs, please report them in the `Github issue tracker <https://github.com/DataverseLabs/pyinterpolate/issues>`_.

Citation
--------
Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, https://doi.org/10.21105/joss.02869

Introduction
............

Expand Down Expand Up @@ -74,7 +78,3 @@ Contents
api/api
api/changes
contributor/development

Citation
--------
Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, https://doi.org/10.21105/joss.02869
2 changes: 1 addition & 1 deletion docs/build/html/contributor/development/tests_and_contribution.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@

<section id="tests-and-contribution">
<h1>Tests and contribution<a class="headerlink" href="#tests-and-contribution" title="Link to this heading">#</a></h1>
<p>All tests are grouped in the <code class="docutils literal notranslate"><span class="pre">test</span></code> directory. If you would like to contribute, then you won’t avoid testing, but it is described step-by-step here: <a class="reference external" href="https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTION.md">CONTRIBUTION.md</a></p>
<p>All tests are grouped in the <code class="docutils literal notranslate"><span class="pre">test</span></code> directory. If you would like to contribute, then you won’t avoid testing, but it is described step-by-step here: <a class="reference external" href="https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a></p>
</section>


Expand Down
14 changes: 8 additions & 6 deletions docs/build/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,13 +410,17 @@ <h1>Pyinterpolate<a class="headerlink" href="#pyinterpolate" title="Link to this
<h2><strong>version 1.1.0</strong><a class="headerlink" href="#version-1-1-0" title="Link to this heading">#</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The last documentation update: <em>2025-10-11</em></p>
<p>The last documentation update: <em>2025-11-08</em></p>
</div>
<section id="important-notice">
<h3>Important notice<a class="headerlink" href="#important-notice" title="Link to this heading">#</a></h3>
<p>The package was updated to version 1.0 in June 2025. There are breaking API changes, so please, refer to the changelog, to know more about the changes.
Right now, the package in version 1.0.0 is in the <strong>beta</strong> stage, which means that it is stable but be careful with the production use. There might be some minor bugs, and large swaths of code are not optimized yet. If you find any bugs, please report them in the <a class="reference external" href="https://github.com/DataverseLabs/pyinterpolate/issues">Github issue tracker</a>.</p>
</section>
</section>
<section id="citation">
<h2>Citation<a class="headerlink" href="#citation" title="Link to this heading">#</a></h2>
<p>Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, <a class="reference external" href="https://doi.org/10.21105/joss.02869">https://doi.org/10.21105/joss.02869</a></p>
<section id="introduction">
<h3>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">#</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">Pyinterpolate</span></code> is the Python library for <strong>spatial statistics</strong>. The package provides access to spatial statistics tools (variogram analysis, Kriging, Poisson Kriging, Indicator Kriging, Inverse Distance Weighting).</p>
Expand Down Expand Up @@ -467,10 +471,6 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">
</ul>
</div>
</section>
<section id="citation">
<h2>Citation<a class="headerlink" href="#citation" title="Link to this heading">#</a></h2>
<p>Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, <a class="reference external" href="https://doi.org/10.21105/joss.02869">https://doi.org/10.21105/joss.02869</a></p>
</section>
</section>


Expand Down Expand Up @@ -513,11 +513,13 @@ <h2>Citation<a class="headerlink" href="#citation" title="Link to this heading">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-1-0"><strong>version 1.1.0</strong></a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#important-notice">Important notice</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#citation">Citation</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#introduction">Introduction</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contents">Contents</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#citation">Citation</a></li>
</ul>
</nav></div>

Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/source/contributor/development/tests_and_contribution.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Tests and contribution
======================

All tests are grouped in the ``test`` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: `CONTRIBUTION.md <https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTION.md>`_
All tests are grouped in the ``test`` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: `CONTRIBUTING.md <https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTING.md>`_