Skip to content

Commit

Permalink
Update documentation with new attributes and more attribute tables
Browse files Browse the repository at this point in the history
  • Loading branch information
SharpBit committed Oct 6, 2024
1 parent ab7e8d6 commit 68d9360
Show file tree
Hide file tree
Showing 4 changed files with 191 additions and 123 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.5"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
3 changes: 3 additions & 0 deletions brawlstats/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ def __str__(self):

def get_members(self) -> Members:
"""Gets the members of a club.
Note: It is preferred to get the members
via Club.members since this method makes
an extra API call but returns the same data.
Returns
-------
Expand Down
Loading

0 comments on commit 68d9360

Please sign in to comment.