[V3 Docs] Docs for utils package (#1085)

* Docstrings for chat formatting

* Docstrings for mod utils

* Type checking

* Override CSS to highlight object name in definition

* More typing

* Utils docs pages

* Fix typo here
This commit is contained in:
Tobotimus
2017-11-20 09:14:05 +11:00
committed by palmtree5
parent b141729830
commit 5cef3e13e1
6 changed files with 361 additions and 27 deletions

11
docs/_static/theme_overrides.css vendored Normal file
View File

@@ -0,0 +1,11 @@
/*
* This overrides the style for the path to each object definition, whilst
* the name of the object remains unchanged.
*
* e.g. in the definition `redbot.core.Config`, `redbot.core` is the
* desclassname.
*/
code.descclassname {
font-weight: normal !important;
}

View File

@@ -103,6 +103,9 @@ html_theme = 'sphinx_rtd_theme'
# html_theme_options = {}
html_context = {
'css_files': [
'_static/theme_overrides.css'
],
# Enable the "Edit in GitHub link within the header of each page.
'display_github': True,
'github_user': 'Cog-Creators',

17
docs/framework_utils.rst Normal file
View File

@@ -0,0 +1,17 @@
.. red's core utils documentation
=================
Utility Functions
=================
Chat Formatting
===============
.. automodule:: redbot.core.utils.chat_formatting
:members:
Mod Helpers
===========
.. automodule:: redbot.core.utils.mod
:members:

View File

@@ -37,6 +37,7 @@ Welcome to Red - Discord Bot's documentation!
framework_i18n
framework_modlog
framework_context
framework_utils