Browse Source

Trying to get the docs to work with rtd

tags/v2.0.0
Roxie Gibson 5 years ago
parent
commit
327ca0f937
3 changed files with 34 additions and 20 deletions
  1. +16
    -8
      docs/commands.md
  2. +11
    -12
      mkdocs.yml
  3. +7
    -0
      readthedocs.yml

+ 16
- 8
docs/commands.md View File

@@ -346,18 +346,26 @@ Example:
Edits settings for the welcome messages

Command Structure:
`;greets option [changes: optional]`

`;greets option [changes: optional]`

Options:
enable/disable: Enable/disables greet messages.
channel: Sets the channel for the message to be posted in. If no channel is provided, it will default to the channel the command is executed in.
message: Specifies a custom message for the greet messages.

`enable/disable`: Enable/disables greet messages.

`channel`: Sets the channel for the message to be posted in. If no channel is provided, it will default to the channel the command is executed in.

`message`: Specifies a custom message for the greet messages.

Example:
Enable greet messages, set the channel to the current one, and set a custom message to be appended.
`;greets enable`
`;greets message "Be sure to read the rules and say hi! :wave:"`
`;greets channel` # if no channel is provided, it will default to the channel the command is executed in.

Enable greet messages, set the channel to the current one, and set a custom message to be appended.

```py
;greets enable
;greets message "Be sure to read the rules and say hi! :wave:"
;greets channel` # if no channel is provided, it will default to the channel the command is executed in.
```


---

+ 11
- 12
mkdocs.yml View File

@@ -45,20 +45,20 @@ nav:

# Customisation
theme:
name: 'material'
name: 'readthedocs'
language: en
palette:
primary: 'deep purple'
accent: 'deep purple'
# palette:
# primary: 'deep purple'
# accent: 'deep purple'
font:
text: 'Roboto'
code: 'Roboto Mono'
logo:
icon: "\uE80C"
feature:
tabs: true
static_templates:
- 404.html
# logo:
# icon: "\uE80C"
# feature:
# tabs: true
# static_templates:
# - 404.html

extra:
social:
@@ -67,8 +67,7 @@ extra:

markdown_extensions:
- admonition
- codehilite:
linenums: true
- codehilite
- toc:
permalink: true
- pymdownx.arithmatex

+ 7
- 0
readthedocs.yml View File

@@ -0,0 +1,7 @@

build:
image: latest

python:
version: 3.6


Loading…
Cancel
Save