Skip to content

Commit 68e1e31

Browse files
committed
✏️ Fix reST syntax and links
1 parent 7699473 commit 68e1e31

76 files changed

Lines changed: 295 additions & 276 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Status
1515
:target: https://github.com/cusyio/python4datascience/graphs/contributors
1616
.. image:: https://img.shields.io/github/license/cusyio/Python4DataScience.svg
1717
:alt: License
18-
:target: https://github.com/cusyio/python4datascience/blob/main/LICENSE
18+
:target: https://github.com/cusyio/Python4DataScience/blob/main/LICENSES/BSD-3-Clause.txt
1919
.. image:: https://results.pre-commit.ci/badge/github/cusyio/Python4DataScience/main.svg
2020
:target: https://results.pre-commit.ci/repo/github/649815375
2121
:alt: pre-commit.ci status
22-
.. image:: https://readthedocs.org/projects/python4datascience/badge/?version=latest
22+
.. image:: https://app.readthedocs.org/projects/python4datascience/badge/?version=latest
2323
:alt: Docs
2424
:target: https://www.python4data.science/en/latest/
2525
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo..14031392.svg

docs/clean-prep/dask-pipeline.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"\n",
1616
"In this notebook we will use two APIs:\n",
1717
"\n",
18-
"1. [Google Maps Geocoder](https://developers.google.com/maps/documentation/geocoding/overview)\n",
18+
"1. [Google Maps Geocoder](https://developers.google.com/maps/documentation/geocoding/guides-v3/overview)\n",
1919
"2. [Open Notify API for ISS location](http://api.open-notify.org)\n",
2020
"\n",
2121
"We will use them to track ISS location and next transit time with respect to a list of cities. To create our charts and parallelise data intelligently, we will use Dask, specifically [Dask Delayed](../performance/dask.ipynb)."

docs/clean-prep/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Expectations <https://greatexpectations.io/>`_ or `MobyDQ
1818

1919
.. tip::
2020
`cusy seminar: Cleanse and validate data with Python
21-
<https://cusy.io/en/our-training-courses/cleanse-and-validate-data-with-python>`_
21+
<https://cusy.io/en/our-training-courses/cleanse-and-validate-data-with-python.html>`_
2222

2323
Overview
2424
--------
@@ -27,7 +27,7 @@ Overview
2727
:header: "Name", "Stars", "Mitwirkende", "Commit-Aktivität", "Lizenz"
2828

2929
"`scikit-learn <https://github.com/scikit-learn/scikit-learn>`_",".. image:: https://raster.shields.io/github/stars/scikit-learn/scikit-learn",".. image:: https://raster.shields.io/github/contributors/scikit-learn/scikit-learn",".. image:: https://raster.shields.io/github/commit-activity/y/scikit-learn/scikit-learn",".. image:: https://raster.shields.io/github/license/scikit-learn/scikit-learn"
30-
"`ydata-profiling <https://github.com/ydataai/ydata-profiling>`_",".. image:: https://raster.shields.io/github/stars/ydataai/ydata-profiling",".. image:: https://raster.shields.io/github/contributors/ydataai/ydata-profiling",".. image:: https://raster.shields.io/github/commit-activity/y/ydataai/ydata-profiling",".. image:: https://raster.shields.io/github/license/ydataai/ydata-profiling"
30+
"`fg-data-profiling <https://github.com/Data-Centric-AI-Community/fg-data-profiling>`_",".. image:: https://raster.shields.io/github/stars/Data-Centric-AI-Community/fg-data-profiling",".. image:: https://raster.shields.io/github/contributors/Data-Centric-AI-Community/fg-data-profiling",".. image:: https://raster.shields.io/github/commit-activity/y/Data-Centric-AI-Community/fg-data-profiling",".. image:: https://raster.shields.io/github/license/Data-Centric-AI-Community/fg-data-profiling"
3131
"`fuzzywuzzy <https://github.com/seatgeek/fuzzywuzzy>`_",".. image:: https://raster.shields.io/github/stars/seatgeek/fuzzywuzzy",".. image:: https://raster.shields.io/github/contributors/seatgeek/fuzzywuzzy",".. image:: https://raster.shields.io/github/commit-activity/y/seatgeek/fuzzywuzzy",".. image:: https://raster.shields.io/github/license/seatgeek/fuzzywuzzy"
3232
"`Hypothesis <https://github.com/HypothesisWorks/hypothesis>`_",".. image:: https://raster.shields.io/github/stars/HypothesisWorks/hypothesis",".. image:: https://raster.shields.io/github/contributors/HypothesisWorks/hypothesis",".. image:: https://raster.shields.io/github/commit-activity/y/HypothesisWorks/hypothesis",".. image:: https://raster.shields.io/github/license/HypothesisWorks/hypothesis"
3333
"`marshmallow <https://github.com/marshmallow-code/marshmallow>`_",".. image:: https://raster.shields.io/github/stars/marshmallow-code/marshmallow",".. image:: https://raster.shields.io/github/contributors/marshmallow-code/marshmallow",".. image:: https://raster.shields.io/github/commit-activity/y/marshmallow-code/marshmallow",".. image:: https://raster.shields.io/github/license/marshmallow-code/marshmallow"

docs/clean-prep/nulls.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1316,7 +1316,7 @@
13161316
"cell_type": "markdown",
13171317
"metadata": {},
13181318
"source": [
1319-
"We then use [pandas.DataFrame.groupby](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.groupby.html) to group the records by `username` and then fill in the missing data using the backfill method from [pandas.core.groupby.DataFrameGroupBy.fillna](https://pandas.pydata.org/docs/reference/api/pandas.core.groupby.DataFrameGroupBy.fillna.html). `limit` defines the maximum number of consecutive `NaN` values:"
1319+
"We then use [pandas.DataFrame.groupby](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.groupby.html) to group the records by `username` and then fill in the missing data using the backfill method from [pandas.api.typing.DataFrameGroupBy.bfill](https://pandas.pydata.org/docs/reference/api/pandas.api.typing.DataFrameGroupBy.bfill.html). `limit` defines the maximum number of consecutive `NaN` values:"
13201320
]
13211321
},
13221322
{

docs/clean-prep/string-matching.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@
505505
"* C#: [FuzzySharp](https://github.com/BoomTownRoi/BoomTown.FuzzySharp)\n",
506506
"* Go: [go-fuzzywuzzy](https://github.com/paul-mannino/go-fuzzywuzzy)\n",
507507
"* Pascal: [FuzzyWuzzy.pas](https://github.com/DavidMoraisFerreira/FuzzyWuzzy.pas)\n",
508-
"* Kotlin: [FuzzyWuzzy-Kotlin](https://github.com/willowtreeapps/fuzzywuzzy-kotlin)\n",
508+
"* Kotlin: [FuzzyWuzzy-Kotlin](https://github.com/jens-muenker/fuzzywuzzy-kotlin)\n",
509509
"* R: [fuzzywuzzyR](https://github.com/mlampros/fuzzywuzzyR)"
510510
]
511511
}

docs/conf.py

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,12 +190,11 @@
190190
r"https://doi.org/10.5281/zenodo.14031392": r"https://zenodo.org/records/14031392",
191191
r"https://itsdangerous.palletsprojects.com/": r"https://itsdangerous.palletsprojects.com/en/2.2.x/",
192192
r"https://jinja.palletsprojects.com/": r"https://jinja.palletsprojects.com/en/3.1.x/",
193-
r"https://www.monetdb.org/Documentation": r"https://www.monetdb.org/documentation-Aug2024/",
194193
r"https://ohwr.org/cern_ohl_p_v2.txt": r"https://ohwr.org/project/cernohl/-/wikis/uploads/3eff4154d05e7a0459f3ddbf0674cae4/cern_ohl_p_v2.txt",
195-
r"https://ohwr.org/cern_ohl_s_v2.txt": r"https://ohwr.org/project/cernohl/-/wikis/uploads/819d71bea3458f71fba6cf4fb0f2de6b/cern_ohl_s_v2.txt",
196-
r"https://ohwr.org/cern_ohl_w_v2.txt": r"https://ohwr.org/project/cernohl/-/wikis/uploads/82b567f43ce515395f7ddbfbad7a8806/cern_ohl_w_v2.txt",
197194
r"https://proj.org/": r"https://proj.org/en/9.5/",
195+
r"https://repository.uantwerpen.be/desktop/irua": r"https://repository.uantwerpen.be/desktop/irua",
198196
r"https://sqlalchemy-imageattach.readthedocs.io/": r"https://sqlalchemy-imageattach.readthedocs.io/en/1.1.0/",
197+
r"https://www.monetdb.org/Documentation": r"https://www.monetdb.org/documentation-Aug2024/",
199198
}
200199

201200
linkcheck_ignore = [
@@ -211,27 +210,47 @@
211210
r"https://github.com/ohmyzsh/ohmyzsh/blob/master/plugins/git/README.md#aliases",
212211
r"https://github.com/spring-projects/spring-framework/blob/30bce7/CONTRIBUTING.md#format-commit-messages",
213212
r"https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing",
213+
r"https://zenodo.org/records/7540792#.Y-QQGK3MKUn",
214214
# 403 Client Error: Forbidden for url
215+
r"https://academic.oup.com/*",
216+
r"https://besjournals.onlinelibrary.wiley.com/journal/*",
215217
r"https://codebeautify.org/yaml-validator",
216218
r"https://collections.plos.org/collection/software/",
217219
r"https://currentprotocols.onlinelibrary.wiley.com/journal/1934340x",
220+
r"https://data.mendeley.com/datasets/wg4bpm33hj/2",
221+
r"https://data.stackexchange.com/",
218222
r"https://data.unicef.org/",
223+
r"https://dataverse.org/",
219224
r"https://direct.mit.edu/artl",
220-
r"https://besjournals.onlinelibrary.wiley.com/journal/*",
221-
r"https://journals.sagepub.com/home/*",
225+
r"https://dl.acm.org/journal/toms",
222226
r"https://doi.org/10.1002/asi.23538",
227+
r"https://exiftool.sourceforge.net/install.html",
228+
r"https://journals.iucr.org/j/",
229+
r"https://journals.sagepub.com/home/*",
223230
r"https://linux.die.net/man/",
224231
r"https://onlinelibrary.wiley.com/",
225232
r"https://opensource.org/",
233+
r"https://peerj.com/articles/cs-86/",
234+
r"https://pubmed.ncbi.nlm.nih.gov/11726920/",
226235
r"https://pubs.acs.org/journal/",
236+
r"https://sourceforge.net/",
237+
r"https://wordnet.princeton.edu/*",
238+
r"https://www.canlii.org/",
227239
r"https://www.cell.com/",
240+
r"https://www.gesis.org/cews/daten-und-informationen/statistiken/datenzugang",
241+
r"https://www.ipums.org/",
228242
r"https://www.journals.elsevier.com/",
243+
r"https://www.lpi.usra.edu/meteor/",
244+
r"https://www.nhtsa.gov/research-data/fatality-analysis-reporting-system-fars",
245+
r"https://www.npmjs.com/*",
246+
r"https://www.oecd.org/en/data.html",
229247
r"https://www.psychonomic.org/",
230248
r"https://www.reddit.com/r/datasets/",
231249
r"https://www.sciencedirect.com/journal/",
250+
r"https://www.sec.gov/submit-filings/about-edgar",
232251
r"https://www.siam.org/publications/journals/",
233-
r"https://sourceforge.net/",
234252
r"https://www.tandfonline.com/",
253+
r"https://zsh.sourceforge.io/",
235254
]
236255

237256

docs/data-processing/apis/fastapi/extensions.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Extensions
88
Administration
99
--------------
1010

11-
`SQLAlchemy Admin for Starlette/FastAPI <https://github.com/aminalaee/sqladmin>`_
11+
`SQLAlchemy Admin for Starlette/FastAPI <https://github.com/smithyhq/sqladmin>`_
1212
Flexible admin interface for :doc:`/data-processing/postgresql/sqlalchemy`
1313
models.
1414

@@ -130,22 +130,23 @@ ORMs
130130
.. image:: https://raster.shields.io/github/license/tortoise/tortoise-orm
131131
:alt: License
132132

133-
`ormar <https://github.com/collerek/ormar/>`_
133+
`ormar <https://github.com/ormar-orm/ormar>`_
134134
Asynchronous mini-ORM, with which you only need to maintain one set of
135135
models and migrate them with :doc:`/data-processing/postgresql/alembic` if
136136
necessary (→ `example
137-
<https://collerek.github.io/ormar/latest/fastapi/>`__); it is also supported
138-
by `fastapi-users <https://github.com/fastapi-users/fastapi-users>`_,
139-
`fastapi-crudrouter <https://github.com/awtkns/fastapi-crudrouter>`_ and
140-
`fastapi-pagination <https://github.com/uriyyo/fastapi-pagination>`_
137+
<https://ormar-orm.github.io/ormar/latest/fastapi/>`__); it is also
138+
supported by `fastapi-users
139+
<https://github.com/fastapi-users/fastapi-users>`_, `fastapi-crudrouter
140+
<https://github.com/awtkns/fastapi-crudrouter>`_ and `fastapi-pagination
141+
<https://github.com/uriyyo/fastapi-pagination>`_
141142

142143
.. image:: https://raster.shields.io/pypi/dm/ormar
143144
:alt: Downloads
144-
.. image:: https://raster.shields.io/github/contributors/collerek/ormar
145+
.. image:: https://raster.shields.io/github/contributors/ormar-orm/ormar
145146
:alt: Contributors
146-
.. image:: https://raster.shields.io/github/commit-activity/y/collerek/ormar
147+
.. image:: https://raster.shields.io/github/commit-activity/y/ormar-orm/ormar
147148
:alt: Commit activity
148-
.. image:: https://raster.shields.io/github/license/collerek/ormar
149+
.. image:: https://raster.shields.io/github/license/ormar-orm/ormar
149150
:alt: License
150151

151152
`Prisma Client Python <https://github.com/RobertCraigie/prisma-client-py>`_
@@ -227,7 +228,7 @@ ODMs
227228
`Beanie <https://github.com/BeanieODM/beanie>`_
228229
Asynchronous Python object document mapper (ODM) for MongoDB, based on
229230
`Motor <https://motor.readthedocs.io/en/stable/>`_ and `Pydantic
230-
<https://docs.pydantic.dev/latest/>`__
231+
<https://pydantic.dev/docs/validation/latest/get-started/>`__
231232

232233
.. image:: https://raster.shields.io/pypi/dm/beanie
233234
:alt: Downloads
@@ -240,7 +241,7 @@ ODMs
240241

241242
`ODMantic <https://github.com/art049/odmantic/>`_
242243
Asynchronous ODM (Object Document Mapper) for MongoDB based on Python type
243-
hints and `pydantic <https://docs.pydantic.dev/latest/>`__
244+
hints and `pydantic <https://pydantic.dev/docs/validation/latest/get-started/>`__
244245

245246
.. image:: https://raster.shields.io/pypi/dm/odmantic
246247
:alt: Downloads
@@ -670,17 +671,17 @@ Dormant projects
670671
.. image:: https://raster.shields.io/github/license/perdy/starlette-prometheus
671672
:alt: Licence
672673

673-
`FastAPI Utilities <https://github.com/dmontagu/fastapi-utils>`_
674+
`FastAPI Utilities <https://github.com/fastapiutils/fastapi-utils>`_
674675
Utilities to reduce boilerplate and reuse common functionality across
675676
projects.
676677

677678
.. image:: https://raster.shields.io/pypi/dm/fastapi-utils
678679
:alt: Downloads
679-
.. image:: https://raster.shields.io/github/contributors/dmontagu/fastapi-utils
680+
.. image:: https://raster.shields.io/github/contributors/fastapiutils/fastapi-utils
680681
:alt: Contributors
681-
.. image:: https://raster.shields.io/github/commit-activity/y/dmontagu/fastapi-utils
682+
.. image:: https://raster.shields.io/github/commit-activity/y/fastapiutils/fastapi-utils
682683
:alt: Commit activity
683-
.. image:: https://raster.shields.io/github/license/dmontagu/fastapi-utils
684+
.. image:: https://raster.shields.io/github/license/fastapiutils/fastapi-utils
684685
:alt: Licence
685686

686687
`Fastapi Camelcase <https://github.com/nf1s/fastapi-camelcase>`_

docs/data-processing/apis/fastapi/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ FastAPI is a web framework for building APIs with Python 3.6+ based type hints.
1010
Key features are:
1111

1212
* very high performance thanks to `pydantic
13-
<https://docs.pydantic.dev/latest/>`_ for the data part and `Starlette
14-
<https://www.starlette.io/>`_ for the web part.
13+
<https://pydantic.dev/docs/validation/latest/get-started/>`_ for the data part
14+
and `Starlette <https://www.starlette.io/>`_ for the web part.
1515

1616
* fast and easy to code
1717
* validation for most Python data types, including

docs/data-processing/apis/fastapi/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Optional requirements
2323
~~~~~~~~~~~~~~~~~~~~~
2424

2525
For production you also need an `ASGI <https://asgi.readthedocs.io/en/latest/>`_
26-
server, such as `uvicorn <http://www.uvicorn.org/>`_:
26+
server, such as `uvicorn <https://uvicorn.dev/>`_:
2727

2828
.. code-block:: console
2929

docs/data-processing/file-systems.rst

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,32 @@ High-level APIs
2323

2424
Integrated file systems:
2525

26-
* `AppFS <https://www.pyfilesystem.org/page/appfs/>`_ for predefined storage
27-
locations in operating systems where applications can store data
28-
* `FTPFS <https://www.pyfilesystem.org/page/ftpfs/>`_ for working with FTP
29-
servers
30-
* `MemoryFS <https://www.pyfilesystem.org/page/memoryfs/>`_ for caches, temporary data storage, unit tests, :abbr:`etc. (et cetera)` that exist in the
31-
working memory
32-
* `MountFS <https://www.pyfilesystem.org/page/mountfs/>`_ for a virtual file
33-
system that can mount other file systems
34-
* `MultiFS <https://www.pyfilesystem.org/page/multifs/>`_ for a virtual file
35-
system that combines other file systems
36-
* `OSFS <https://www.pyfilesystem.org/page/osfs/>`_ for the OS file system
37-
* `TarFS <https://www.pyfilesystem.org/page/tarfs/>`_ reads and writes
38-
compressed tar archives
39-
* `TempFS <https://www.pyfilesystem.org/page/tempfs/>`_ contains temporary
40-
data
41-
* `ZipFS <https://www.pyfilesystem.org/page/zipfs/>`_ reads and writes Zip
42-
files
26+
* `AppFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/appfs.html>`_
27+
for predefined storage locations in operating systems where applications
28+
can store data
29+
* `FTPFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/ftpfs.html>`_
30+
for working with FTP servers
31+
* `MemoryFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/memoryfs.html>`_
32+
for caches, temporary data storage, unit tests, :abbr:`etc. (et cetera)`
33+
that exist in the working memory
34+
* `MountFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/mountfs.html>`_
35+
for a virtual file system that can mount other file systems
36+
* `MultiFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/multifs.html>`_
37+
for a virtual file system that combines other file systems
38+
* `OSFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/osfs.html>`_
39+
for the OS file system
40+
* `TarFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/zipfs.html>`_
41+
reads and writes compressed tar archives
42+
* `TempFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/tempfs.html?highlight=tempfs#module-fs.tempfs>`_
43+
contains temporary data
44+
* `ZipFS <https://pyfilesystem2.readthedocs.io/en/latest/reference/zipfs.html>`_
45+
reads and writes Zip files
4346

4447
File systems of the PyFilesystem organization on GitHub:
4548

46-
* `DropBoxFS <https://www.pyfilesystem.org/page/dropboxfs/>`_
47-
* `S3FS <https://www.pyfilesystem.org/page/s3fs/>`_
48-
* `WebDavFS <https://www.pyfilesystem.org/page/index-of-filesystems/>`_
49+
* `DropBoxFS <https://github.com/PyFilesystem/fs.dropboxfs>`_
50+
* `S3FS <https://github.com/PyFilesystem/s3fs>`_
51+
* `WebDavFS <https://github.com/PyFilesystem/webdavfs>`_
4952

5053
File systems from third-party developers:
5154

@@ -59,8 +62,6 @@ High-level APIs
5962
* `fs.smbfs <https://github.com/althonos/fs.smbfs>`_ for Samba
6063
* `fs.sshfs <https://github.com/althonos/fs.sshfs>`_ for SSH with
6164
:ref:`paramiko`
62-
* `mp-fs-wsgidav <https://github.com/mikespub-org/mp-fs-wsgidav>`_ for
63-
WsgiDAV
6465

6566
.. _fsspec:
6667

@@ -91,11 +92,11 @@ High-level APIs
9192
* `boxfs <https://github.com/IBM/boxfs>`_ for access to Box file storage
9293
* `dropbox <https://github.com/fsspec/dropboxdrivefs>`_ for access to
9394
Dropbox shares
94-
* `dvc <https://github.com/iterative/dvc>`_ for accessing a DVC repository
95+
* `dvc <https://github.com/treeverse/dvc>`_ for accessing a DVC repository
9596
as a file system
9697
* `gcsfs <https://github.com/fsspec/gcsfs>`_ for Google Cloud Storage
97-
* `gdrive <https://github.com/fsspec/gdrivefs>`_ for access to Google Drive
98-
and shares
98+
* `gdrive <https://github.com/fsspec/gdrive-fsspec>`_ for access to Google
99+
Drive and shares
99100
* `huggingface_hub
100101
<https://huggingface.co/docs/huggingface_hub/main/en/guides/hf_file_system>`_
101102
for access to the Hugging Face Hub file system
@@ -192,7 +193,7 @@ Specialised libraries
192193
.. image::
193194
https://raster.shields.io/github/license/aliyun/aliyun-oss-python-sdk
194195

195-
`minio <https://min.io/docs/minio/linux/developers/python/minio-py.html>`_
196+
`minio <https://docs.min.io/aistor/developers/sdk/python/>`_
196197
MinIO Python Client SDK for Amazon S3 compatible cloud storage.
197198

198199
.. image::

0 commit comments

Comments
 (0)