Skip to content

Commit 015b0d7

Browse files
Merge pull request #503 from DataverseLabs/494-link-to-nonexistent-contributionmd
Corrected broken links to CONTRIBUTING.md file in README and document…
2 parents e02a7f7 + 1cf108a commit 015b0d7

File tree

11 files changed

+19
-16
lines changed

11 files changed

+19
-16
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Changes - from version >= 1.x
4040
* [docs] updated tutorials - new parameters are used in kriging operations, and when experimental variogram is computed
4141
* [docs] added missing badges (Python version and package version)
4242
* [docs] `CITATION.cff`, citation section in readme has been moved up, bibtex citation has been added
43+
* [docs] corrected broken links to `CONTRIBUTING.md` file in readme and docs
4344
* # todo [docs] docstring examples - all user-facing API endpoints has examples in docstrings, using new input types (values | geometries)
4445

4546
2025-10-11

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ A world of advice, you should **always** use Virtual Environment for the install
178178

179179
## Tests and contribution
180180

181-
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)
181+
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)
182182

183183
## Use cases
184184

Binary file not shown.
40 Bytes
Binary file not shown.

docs/build/doctrees/index.doctree

33 Bytes
Binary file not shown.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Tests and contribution
22
======================
33

4-
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>`_
4+
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>`_

docs/build/html/_sources/index.rst.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,18 @@ Pyinterpolate
1414
-----------------
1515

1616
.. note::
17-
The last documentation update: *2025-10-11*
17+
The last documentation update: *2025-11-08*
1818

1919
Important notice
2020
................
2121

2222
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.
2323
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>`_.
2424

25+
Citation
26+
--------
27+
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
28+
2529
Introduction
2630
............
2731

@@ -74,7 +78,3 @@ Contents
7478
api/api
7579
api/changes
7680
contributor/development
77-
78-
Citation
79-
--------
80-
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

docs/build/html/contributor/development/tests_and_contribution.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@
444444

445445
<section id="tests-and-contribution">
446446
<h1>Tests and contribution<a class="headerlink" href="#tests-and-contribution" title="Link to this heading">#</a></h1>
447-
<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>
447+
<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>
448448
</section>
449449

450450

docs/build/html/index.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -410,13 +410,17 @@ <h1>Pyinterpolate<a class="headerlink" href="#pyinterpolate" title="Link to this
410410
<h2><strong>version 1.1.0</strong><a class="headerlink" href="#version-1-1-0" title="Link to this heading">#</a></h2>
411411
<div class="admonition note">
412412
<p class="admonition-title">Note</p>
413-
<p>The last documentation update: <em>2025-10-11</em></p>
413+
<p>The last documentation update: <em>2025-11-08</em></p>
414414
</div>
415415
<section id="important-notice">
416416
<h3>Important notice<a class="headerlink" href="#important-notice" title="Link to this heading">#</a></h3>
417417
<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.
418418
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>
419419
</section>
420+
</section>
421+
<section id="citation">
422+
<h2>Citation<a class="headerlink" href="#citation" title="Link to this heading">#</a></h2>
423+
<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>
420424
<section id="introduction">
421425
<h3>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">#</a></h3>
422426
<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>
@@ -467,10 +471,6 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">
467471
</ul>
468472
</div>
469473
</section>
470-
<section id="citation">
471-
<h2>Citation<a class="headerlink" href="#citation" title="Link to this heading">#</a></h2>
472-
<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>
473-
</section>
474474
</section>
475475

476476

@@ -513,11 +513,13 @@ <h2>Citation<a class="headerlink" href="#citation" title="Link to this heading">
513513
<ul class="visible nav section-nav flex-column">
514514
<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">
515515
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#important-notice">Important notice</a></li>
516+
</ul>
517+
</li>
518+
<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">
516519
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#introduction">Introduction</a></li>
517520
</ul>
518521
</li>
519522
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contents">Contents</a></li>
520-
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#citation">Citation</a></li>
521523
</ul>
522524
</nav></div>
523525

docs/build/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)