update styles

botisimo · Jan 27, 2020 · 0dec69a · 0dec69a
1 parent a36aaa2
commit 0dec69a
Show file tree

Hide file tree

Showing 18 changed files with 77 additions and 40 deletions.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,20 @@
+.wy-side-nav-search {
+    background-color: black;
+}
+
+a {
+    color: #5BC2A8;
+}
+
+a:visited {
+    color: #5BC2A8;
+}
+
+a:active {
+    color: #5BC2A8;
+}
+
+a:hover {
+    color: #5BC2A8;
+    text-decoration: underline;
+}
diff --git a/docs/commands/bridge.rst b/docs/commands/bridge.rst
@@ -11,10 +11,6 @@ __ #delete
 __ #join
 __ #new
 
-.. note::
-
-    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
-
 delete
 ^^^^^^
 Delete a bridge

diff --git a/docs/commands/command.rst b/docs/commands/command.rst
@@ -21,10 +21,6 @@ __ #list
 __ #new
 __ #permission
 
-.. note::
-
-    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
-
 .. note::
 
     Commands are enabled and disabled based on the platform (Twitch, Mixer, YouTube, etc.) the command was issued from. Commands will respond to the channel they are called from.

diff --git a/docs/commands/giveaway.rst b/docs/commands/giveaway.rst
@@ -19,10 +19,6 @@ __ #rules
 __ #view
 __ #winner
 
-.. note::
-
-    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
-
 .. note::
 
     You can display the active giveaway in your stream using the `stream overlay <https://botisimo.com/account/overlays>`_ for giveaways.

diff --git a/docs/commands/index.rst b/docs/commands/index.rst
@@ -3,6 +3,10 @@ Commands
 
 Commands are used to allow you and your moderators/users to interact with the bot via chat.
 
+.. note::
+
+    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
+
 .. note::
 
     If viewers are not receiving whispers from Botisimo in Twitch, they may need to send it a whisper first to get it working for their account.

diff --git a/docs/commands/login.rst b/docs/commands/login.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 !login (Discord only)
 =====================
 

diff --git a/docs/commands/logout.rst b/docs/commands/logout.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 !logout (Discord only)
 ======================
 

diff --git a/docs/commands/playlists.rst b/docs/commands/playlists.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 !playlists (Discord only)
 =========================
 

diff --git a/docs/commands/poll.rst b/docs/commands/poll.rst
@@ -17,10 +17,6 @@ __ #open
 __ #view
 __ #winner
 
-.. note::
-
-    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
-
 .. note::
 
     You can display the active poll in your stream using the `stream overlay <https://botisimo.com/account/overlays>`_ for polls.

diff --git a/docs/commands/timer.rst b/docs/commands/timer.rst
@@ -19,10 +19,6 @@ __ #new
 __ #start
 __ #stop
 
-.. note::
-
-    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
-
 .. note::
 
     Timers are started and stopped based on the platform (Twitch, Mixer, YouTube, etc.) the command was issued from. Timers will only post to a single channel per platform.

diff --git a/docs/commands/vote.rst b/docs/commands/vote.rst
@@ -3,10 +3,6 @@
 
 The ``!vote`` command is used to vote in `polls <https://botisimo.com/account/polls>`_ via chat.
 
-.. note::
-
-    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
-
 .. warning::
 
     Casting multiple votes for a poll may disqualify you from the poll if enabled by the streamer.

diff --git a/docs/conf.py b/docs/conf.py
@@ -47,6 +47,34 @@
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
+# Theme options
+html_theme_options = {
+    # 'typekit_id': 'hiw1hhg',
+    # 'analytics_id': '',
+    # 'sticky_navigation': True  # Set to False to disable the sticky nav while scrolling.
+    'logo_only': True,  # if we have a html_logo below, this shows /only/ the logo with no title text
+    'collapse_navigation': False,  # Collapse navigation (False makes it tree-like)
+    # 'display_version': True,  # Display the docs version
+    # 'navigation_depth': 4,  # Depth of the headers shown in the navigation bar
+}
+
+# VCS options: https://docs.readthedocs.io/en/latest/vcs.html#github
+html_context = {
+    "display_github": True, # Integrate GitHub
+    "github_user": "botisimochatbot", # Username
+    "github_repo": "botisimo-documentation", # Repo name
+    "github_version": "master", # Version
+    "conf_py_path": "/", # Path in the checkout to the docs root
+}
+
+html_logo = 'images/botisimo-logo.png'
+
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    'css/custom.css',
+]
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

diff --git a/docs/directives/index.rst b/docs/directives/index.rst
@@ -3,6 +3,10 @@ Directives
 
 Response directives are used to make dynamic actions for your `custom commands <https://botisimo.com/account/commands>`_. Directives will be processed after :doc:`response variables </variables/index>` and in the order they appear in the response text.
 
+.. note::
+
+    If a directive argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
+
 .. toctree::
    :maxdepth: 1
    :name: toc-directives

diff --git a/docs/images/botisimo-avatar.png b/docs/images/botisimo-avatar.png
diff --git a/docs/images/botisimo-logo.png b/docs/images/botisimo-logo.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -26,19 +26,12 @@ Many features of Botisimo require moderator privileges in your channel. It is hi
 
 :doc:`Learn How to Make Botisimo a Moderator → <moderator>`
 
-.. toctree::
-   :maxdepth: 1
-   :name: sec-moderation
-   :hidden:
-
-   moderator
-
 Commands
 ^^^^^^^^
 
 Commands are used to allow you and your moderators/users to interact with the bot via chat.
 
-:doc:`View All Available Commands → <commands/index>`
+:doc:`View All Commands → <commands/index>`
 
 .. toctree::
    :maxdepth: 1
@@ -47,12 +40,12 @@ Commands are used to allow you and your moderators/users to interact with the bo
 
    commands/index
 
-Response Variables
-^^^^^^^^^^^^^^^^^^
+Variables
+^^^^^^^^^
 
 Response variables are used to make dynamic `custom command <https://botisimo.com/account/commands>`_ responses.
 
-:doc:`View All Available Variables → <variables/index>`
+:doc:`View All Variables → <variables/index>`
 
 .. toctree::
    :maxdepth: 1
@@ -61,12 +54,12 @@ Response variables are used to make dynamic `custom command <https://botisimo.co
 
    variables/index
 
-Response Directives
-^^^^^^^^^^^^^^^^^^^
+Directives
+^^^^^^^^^^
 
 Response directives are used to make dynamic actions for your `custom commands <https://botisimo.com/account/commands>`_. Directives will be processed after :doc:`response variables <variables/index>` and in the order they appear in the response text.
 
-:doc:`View All Available Directives → <directives/index>`
+:doc:`View All Directives → <directives/index>`
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/moderator.rst b/docs/moderator.rst
@@ -1,5 +1,7 @@
-Making Botisimo Moderator
-=========================
+:orphan:
+
+Make Botisimo Moderator
+=======================
 
 Many features of Botisimo will require moderator privileges in your channel. For example, if you want to create commands to respond with hyperlinks or if you want to use the spam filters to automatically delete unwanted messages and timeout users.
 

diff --git a/docs/variables/index.rst b/docs/variables/index.rst
@@ -3,6 +3,10 @@ Variables
 
 Response variables are used to make dynamic `custom command <https://botisimo.com/account/commands>`_ responses. See also :doc:`response directives </directives/index>`.
 
+.. note::
+
+    If a variable argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
+
 .. toctree::
    :maxdepth: 1
    :name: toc-variables