Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,38 @@ build/*
dist/*
*/*/AGENTS.md
**/.DS_Store
docs/_build/doctrees/contributing.doctree
docs/_build/doctrees/environment.pickle
docs/_build/doctrees/index.doctree
docs/_build/doctrees/installation.doctree
docs/_build/doctrees/readme.doctree
docs/_build/doctrees/usage.doctree
docs/_build/html/.buildinfo
docs/_build/html/.buildinfo.bak
docs/_build/html/contributing.html
docs/_build/html/genindex.html
docs/_build/html/index.html
docs/_build/html/installation.html
docs/_build/html/objects.inv
docs/_build/html/readme.html
docs/_build/html/search.html
docs/_build/html/searchindex.js
docs/_build/html/usage.html
docs/_build/html/_sources/contributing.md.txt
docs/_build/html/_sources/index.rst.txt
docs/_build/html/_sources/installation.rst.txt
docs/_build/html/_sources/readme.md.txt
docs/_build/html/_sources/usage.rst.txt
docs/_build/html/_static/alabaster.css
docs/_build/html/_static/basic.css
docs/_build/html/_static/custom.css
docs/_build/html/_static/doctools.js
docs/_build/html/_static/documentation_options.js
docs/_build/html/_static/file.png
docs/_build/html/_static/github-banner.svg
docs/_build/html/_static/language_data.js
docs/_build/html/_static/minus.png
docs/_build/html/_static/plus.png
docs/_build/html/_static/pygments.css
docs/_build/html/_static/searchtools.js
docs/_build/html/_static/sphinx_highlight.js
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ sdc.get_ranges_df(
(1.0, 1.5] Positive 0 0 0.0000 0.0 %
```

See [examples/basic_usage.py](examples/basic_usage.py) for a complete example with synthetic data showing transient correlations.
See [examples/basic_usage.py](https://github.com/AlFontal/sdcpy/blob/master/examples/basic_usage.py) for a complete example with synthetic data showing transient correlations.

## Development

Expand All @@ -151,7 +151,7 @@ uv sync --all-groups
uv run pytest
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
See [CONTRIBUTING.md](https://github.com/AlFontal/sdcpy/blob/master/CONTRIBUTING.md) for more details.

## References

Expand Down
1 change: 1 addition & 0 deletions docs/_static/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Welcome to sdcpy's documentation!
readme
installation
usage
modules
contributing

Indices and tables
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Once you have a copy of the source, you can install it with:

.. code-block:: console

$ python setup.py install
$ pip install .


.. _Github repo: https://github.com/AlFontal/sdcpy
Expand Down
Loading