[PR #321] [MERGED] Improve docs #461

New issue

Closed

opened 2026-03-02 15:58:03 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 15:58:03 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/probberechts/soccerdata/pull/321
Author: @probberechts
Created: 8/1/2023
Status: ✅ Merged
Merged: 8/1/2023
Merged by: @probberechts

Base: master ← Head: docs

📝 Commits (1)

248828e Improve docs

📊 Changes

20 files changed (+1706 additions, -302 deletions)

View changed files

📝 .bumpversion.cfg (+4 -0)
📝 README.rst (+16 -10)
📝 docs/_static/default.css (+4 -0)
📝 docs/conf.py (+66 -0)
📝 docs/datasources/index.rst (+99 -22)
➕ docs/examples/ClubElo - Evolution of current top teams.ipynb (+303 -0)
➕ docs/examples/MatchHistory - Home advantage.ipynb (+657 -0)
➕ docs/examples/index.rst (+13 -0)
➕ docs/faq.rst (+55 -0)
➕ docs/howto/custom-leagues.rst (+141 -0)
➕ docs/howto/index.rst (+14 -0)
➕ docs/howto/proxy.rst (+29 -0)
📝 docs/index.rst (+42 -31)
➕ docs/intro.rst (+208 -0)
➕ docs/reference/base.rst (+22 -0)
📝 docs/reference/index.rst (+13 -21)
📝 docs/reference/sofifa.rst (+2 -1)
➕ docs/reference/utils.rst (+10 -0)
➕ docs/topics/index.rst (+8 -0)
➖ docs/usage.rst (+0 -217)

📄 Description

Add overview of main features to index page
Refactor the "Getting Started" guide
Refactor the overview of supported data sources
Add "How-to guides" section
Add a detailed how-to guide on adding additional leagues (Fixes #104)
Add examples of data analysis using data scraped with SoccerData
Add soccerdata._common module to the API reference
Add FAQ page

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/probberechts/soccerdata/pull/321 **Author:** [@probberechts](https://github.com/probberechts) **Created:** 8/1/2023 **Status:** ✅ Merged **Merged:** 8/1/2023 **Merged by:** [@probberechts](https://github.com/probberechts) **Base:** `master` ← **Head:** `docs` --- ### 📝 Commits (1) - [`248828e`](https://github.com/probberechts/soccerdata/commit/248828ee075abf01a6e526bde383ae222de6d23b) Improve docs ### 📊 Changes **20 files changed** (+1706 additions, -302 deletions) <details> <summary>View changed files</summary> 📝 `.bumpversion.cfg` (+4 -0) 📝 `README.rst` (+16 -10) 📝 `docs/_static/default.css` (+4 -0) 📝 `docs/conf.py` (+66 -0) 📝 `docs/datasources/index.rst` (+99 -22) ➕ `docs/examples/ClubElo - Evolution of current top teams.ipynb` (+303 -0) ➕ `docs/examples/MatchHistory - Home advantage.ipynb` (+657 -0) ➕ `docs/examples/index.rst` (+13 -0) ➕ `docs/faq.rst` (+55 -0) ➕ `docs/howto/custom-leagues.rst` (+141 -0) ➕ `docs/howto/index.rst` (+14 -0) ➕ `docs/howto/proxy.rst` (+29 -0) 📝 `docs/index.rst` (+42 -31) ➕ `docs/intro.rst` (+208 -0) ➕ `docs/reference/base.rst` (+22 -0) 📝 `docs/reference/index.rst` (+13 -21) 📝 `docs/reference/sofifa.rst` (+2 -1) ➕ `docs/reference/utils.rst` (+10 -0) ➕ `docs/topics/index.rst` (+8 -0) ➖ `docs/usage.rst` (+0 -217) </details> ### 📄 Description - Add overview of main features to index page - Refactor the "Getting Started" guide - Refactor the overview of supported data sources - Add "How-to guides" section - Add a detailed how-to guide on adding additional leagues (Fixes #104) - Add examples of data analysis using data scraped with SoccerData - Add `soccerdata._common` module to the API reference - Add FAQ page --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>