Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@ghiggi
ghiggi committed Apr 7, 2024
1 parent 31dd138 commit 90d0d24
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 16 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Refer to the table below for a comprehensive summary of all CI tools employed to
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Tool | Aim |
+====================================================+=====================================================================================================================================+
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit (as defined in `.pre-commit-config.yaml <https://github.com/ltelab/tstore/blob/main/.pre-commit-config.yaml>`__) |
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit (as defined in `.pre-commit-config.yaml <https://github.com/ltelab/tstore/blob/main/.pre-commit-config.yaml>`__) |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Expand Down
17 changes: 9 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
| Python Versions | [![Python Versions](https://img.shields.io/badge/Python-3.9%20%203.10%20%203.11%20%203.12-blue?style=flat)](https://www.python.org/downloads/) |
| Supported Systems | [![Linux](https://img.shields.io/github/actions/workflow/status/ltelab/tstore/.github/workflows/tests.yml?label=Linux&style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [![macOS](https://img.shields.io/github/actions/workflow/status/ltelab/tstore/.github/workflows/tests.yml?label=macOS&style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [![Windows](https://img.shields.io/github/actions/workflow/status/ltelab/tstore/.github/workflows/tests_windows.yml?label=Windows&style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests_windows.yml) |
| Project Status | [![Project Status](https://www.repostatus.org/badges/latest/active.svg?style=flat)](https://www.repostatus.org/#active) |
| Build Status | [![Tests](https://github.com/ltelab/tstore/actions/workflows/tests.yml/badge.svg?style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [![Lint](https://github.com/ltelab/tstore/actions/workflows/lint.yml/badge.svg?style=flat)](https://github.com/ltelab/tstore/actions/workflows/lint.yml) [![Docs](https://readthedocs.org/projects/ts-store/badge/?version=latest&style=flat)](https://ts-store.readthedocs.io/en/latest/) |
| Build Status | [![Tests](https://github.com/ltelab/tstore/actions/workflows/tests.yml/badge.svg?style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [![Lint](https://github.com/ltelab/tstore/actions/workflows/lint.yml/badge.svg?style=flat)](https://github.com/ltelab/tstore/actions/workflows/lint.yml) [![Docs](https://readthedocs.org/projects/ts-store/badge/?version=latest&style=flat)](https://tstore.readthedocs.io/en/latest/) |
| Linting | [![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat)](https://github.com/astral-sh/ruff) [![Codespell](https://img.shields.io/badge/Codespell-enabled-brightgreen?style=flat)](https://github.com/codespell-project/codespell) |
| Code Coverage | [![Coveralls](https://coveralls.io/repos/github/ltelab/tstore/badge.svg?branch=main&style=flat)](https://coveralls.io/github/ltelab/tstore?branch=main) [![Codecov](https://codecov.io/gh/ltelab/tstore/branch/main/graph/badge.svg?style=flat)](https://codecov.io/gh/ltelab/tstore) |
| Code Quality | [![Codefactor](https://www.codefactor.io/repository/github/ltelab/tstore/badge?style=flat)](https://www.codefactor.io/repository/github/ltelab/tstore) [![Codebeat](https://codebeat.co/badges/664f3ba2-a3b5-4a82-8e0c-7024063f210a?style=flat)](https://codebeat.co/projects/github-com-ltelab-tstore-main) [![Codacy](https://app.codacy.com/project/badge/Grade/7bcd3144d96c40cfac16d9cbd609770c?style=flat)](https://app.codacy.com/gh/ltelab/tstore/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Codescene](https://codescene.io/projects/41868/status-badges/code-health?style=flat)](https://codescene.io/projects/41868) |
| License | [![License](https://img.shields.io/github/license/ltelab/tstore?style=flat)](https://github.com/ltelab/tstore/blob/main/LICENSE) |
| Community | [![Slack](https://img.shields.io/badge/Slack-tstore-green.svg?logo=slack&style=flat)](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) [![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-green?logo=github&style=flat)](https://github.com/ltelab/tstore/discussions) |
| Citation | [![DOI](https://zenodo.org/badge/286664485.svg?style=flat)](https://doi.org/10.5281/zenodo.7753488) |

[**Slack**](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) | [**Docs**](https://ts-store.readthedocs.io/en/latest/)
[**Slack**](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) | [**Docs**](https://tstore.readthedocs.io/en/latest/)

## 🚀 Quick start

Expand All @@ -29,7 +29,7 @@ ______________________________________________________________________

To discover all TStore download, manipulation, analysis and plotting utilities, or how to contribute your custom retrieval to TStore:

- please read the software documentation available at [https://ts-store.readthedocs.io/en/latest/](https://ts-store.readthedocs.io/en/latest/).
- please read the software documentation available at [https://tstore.readthedocs.io/en/latest/](https://tstore.readthedocs.io/en/latest/).
- dive into the Jupyter Notebooks [Tutorials](https://github.com/ltelab/tstore/tree/main/tutorials).

## 🛠️ Installation
Expand Down Expand Up @@ -58,6 +58,12 @@ pip install ts-store

To install the latest development version via pip, see the [documentation][dev_install_link].

[conda_forge_link]: https://github.com/conda-forge/ts-store-feedstock#installing-ts-store
[conda_link]: https://docs.conda.io/en/latest/miniconda.html
[dev_install_link]: https://tstore.readthedocs.io/en/latest/02_installation.html#installation-for-contributors
[pip_link]: https://pypi.org/project/ts-store
[winpy_link]: https://winpython.github.io/

## 💭 Feedback and Contributing Guidelines

If you aim to contribute your data or discuss the future development of TStore,
Expand Down Expand Up @@ -116,8 +122,3 @@ pre-commit install --hook-type commit-msg

- Based on the [cookiecutter-data-snake :snake:](https://github.com/martibosch/cookiecutter-data-snake) template for reproducible data science.

[conda_forge_link]: https://github.com/conda-forge/ts-store-feedstock#installing-ts-store
[conda_link]: https://docs.conda.io/en/latest/miniconda.html
[dev_install_link]: https://ts-store.readthedocs.io/en/latest/02_installation.html#installation-for-contributors
[pip_link]: https://pypi.org/project/ts-store
[winpy_link]: https://winpython.github.io/
12 changes: 6 additions & 6 deletions docs/source/07_maintainers_guidelines.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,17 +199,17 @@ The table below summarizes the software tools utilized in our CI pipeline, descr
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `Ruff <https://github.com/charliermarsh/ruff>`__ | Python linter | |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit as defined in `.pre-commit-config.yaml <https://github.com/ltelab/tstore/blob/main/.pre-commit-config.yaml>`__ |
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit as defined in `.pre-commit-config.yaml <https://github.com/ltelab/tstore/blob/main/.pre-commit-config.yaml>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `Coverage <https://coverage.readthedocs.io/>`__ | Measure the code coverage of the project's unit tests | |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `CodeCov <https://about.codecov.io/>`__ | Uses the "coverage" package to generate a code coverage report. | `TStore <https://app.codecov.io/gh/ltelab/tstore>`__ |
| `CodeCov <https://about.codecov.io/>`__ | Uses the "coverage" package to generate a code coverage report. | `TStore <https://app.codecov.io/gh/ltelab/tstore>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `Coveralls <https://coveralls.io/>`__ | Uses the "coverage" to track the quality of your code over time. | `TStore <https://coveralls.io/github/ltelab/tstore>`__ |
| `Coveralls <https://coveralls.io/>`__ | Uses the "coverage" to track the quality of your code over time. | `TStore <https://coveralls.io/github/ltelab/tstore>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools | `TStore <https://codebeat.co/projects/github-com-ltelab/tstore>`__ |
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools | `TStore <https://codebeat.co/projects/github-com-ltelab-tstore-main>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools | `TStore <https://codescene.io/projects/36767/>`__ |
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools | `TStore <https://codescene.io/projects/41868/>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `CodeFactor <https://www.codefactor.io/>`__ | Automated code review and analysis tools | `TStore <https://www.codefactor.io/repository/github/ltelab/tstore>`__ |
| `CodeFactor <https://www.codefactor.io/>`__ | Automated code review and analysis tools | `TStore <https://www.codefactor.io/repository/github/ltelab/tstore>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
2 changes: 1 addition & 1 deletion tstore/tsdf/extensions/ts_dtype.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def construct_from_string(cls, string: str):
Construct an TSDtype from a string.
Example:
-------
---------
>>> TSDtype.construct_from_string("TS[pandas]")
TS['pandas']
"""
Expand Down

0 comments on commit 90d0d24

Please sign in to comment.