Skip to content

Commit

Permalink
docs: update sphinx to 5.0.1 and write more docs (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronhnsy committed Jun 14, 2022
1 parent c99f679 commit 28c57b1
Show file tree
Hide file tree
Showing 26 changed files with 822 additions and 406 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ python:
- method: pip
path: .
extra_requirements:
- dev
- docs
18 changes: 8 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,41 +106,39 @@
##############

# autodoc
autodoc_class_signature: str = "separated"
autoclass_content: str = "class"
autodoc_class_signature: str = "mixed"
autodoc_member_order: str = "bysource"
autodoc_default_options: dict[str, Any] = {
"undoc-members": True
}
autodoc_typehints: str = "signature"
autodoc_typehints_description_target: str = "documented"
autodoc_type_aliases: dict[str, str] = {
# "BotT": "~discord.ext.commands.Bot | ~discord.ext.commands.AutoShardedBot",
# "ContextT": "~discord.ext.commands.Context",
# "PlayerT": "~slate.Player",
"VoiceChannel": "~discord.VoiceChannel | ~discord.StageChannel",
"BotT": "~discord.ext.commands.Bot",
"ContextT": "~discord.ext.commands.Context",
"PlayerT": "~slate.Player",
"QueueItemT": "~slate.Track",
}
autodoc_typehints_format: str = "short"


# napoleon
napoleon_use_admonition_for_examples: bool = True
napoleon_use_admonition_for_notes: bool = True


# intersphinx
intersphinx_mapping: dict[str, tuple[str, None]] = {
"aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
"python": ("https://docs.python.org/3.10", None),
"discord": ("https://discordpy.readthedocs.io/en/master", None),
"discord": ("https://discordpy.readthedocs.io/en/latest", None),
}


# ext links
extlinks: dict[str, tuple[str, str]] = {
"issue": (f"{_GITHUB}/issues/%s", "GH-"),
}
extlinks_detect_hardcoded_links: bool = True


# resource links
resource_links: dict[str, str] = {
"github": _GITHUB,
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ This installs the latest stable release of slate from github
python3 -m pip install -U git+https://github.com/Axelware/[email protected]
Installing Developement Version
Installing Development Version
-------------------------------
This installs the master branch from github

.. admonition:: Warning
:class: attention

Installing the developement version is not recommended as the it might have bugs.
Installing the development version is not recommended as the it might have bugs.

.. tab:: Windows

Expand Down
Loading

0 comments on commit 28c57b1

Please sign in to comment.