Added docs folder

docs for storing documentation of rtd

Author: GreatTaku

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = DiscordpyExamples
+SPHINXPROJ    = DiscordBotExamples
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/_templates/customtoc.html

@@ -0,0 +1,2 @@
+<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
+{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False,includehidden=theme_globaltoc_includehidden|tobool) }}</ul>

docs/async.rst

@@ -0,0 +1,16 @@
+.. currentmodule:: async
+
+Async Branch Examples
+=====================
+
+This is the documentation for examples that uses the async branch of Discord.py.
+
+Example 1
+---------
+
+pass
+
+Example 2
+---------
+
+pass

docs/conf.py

@@ -12,14 +12,15 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Discord.py Examples'
+project = 'Discord Bot Examples'
 copyright = '2018, Taku'
 author = 'Taku'
 
@@ -42,6 +43,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -71,6 +73,7 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'default'
 
+highlight_language = 'python3'
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -83,8 +86,13 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
-
+html_theme_options = {'show_powered_by': True,
+                      'github_button': True,
+                      # 'github_banner': True,
+                      'github_user': 'GreatTaku',
+                      'github_repo': project,
+                      'show_related': True,
+                      }
 # 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".
@@ -99,12 +107,13 @@
 # 'searchbox.html']``.
 #
 # html_sidebars = {}
+html_show_sourcelink = False
 
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'DiscordpyExamplesdoc'
+htmlhelp_basename = 'DiscordBotExamplesdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -131,17 +140,22 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'DiscordpyExamples.tex', 'Discord.py Examples Documentation',
+    (master_doc, 'DiscordBotExamples.tex', 'Discord Bot Examples Documentation',
      'Taku', 'manual'),
 ]
 
+html_sidebars = {'**': ['customtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']}
+
+html_context = {
+    'theme_globaltoc_depth': '2',
+}
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'discordpyexamples', 'Discord.py Examples Documentation',
+    (master_doc, 'discordbotexamples', 'Discord Bot Examples Documentation',
      [author], 1)
 ]
 
@@ -152,15 +166,18 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'DiscordpyExamples', 'Discord.py Examples Documentation',
-     author, 'DiscordpyExamples', 'One line description of project.',
+    (master_doc, 'DiscordBotExamples', 'Discord Bot Examples Documentation',
+     author, 'DiscordBotExamples', 'One line description of project.',
      'Miscellaneous'),
 ]
 
 
 # -- Extension configuration -------------------------------------------------
 
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/dev/': None}
+intersphinx_mapping = {'https://docs.python.org/dev/': None}

docs/index.rst

@@ -1,20 +1,22 @@
-.. Discord.py Examples documentation master file, created by
-   sphinx-quickstart on Fri May 11 17:45:21 2018.
+.. Discord Bot Examples documentation master file, created by
+   sphinx-quickstart on Fri May 11 20:03:41 2018.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Discord.py (Examples) documentation!
-====================================
+=================================
+Discord Bot Examples Explanations
+=================================
 
+A repository containing well-documented and easy-to-learn examples involving the use of Discord.py library.
 
 
-REFERENCES
-==========
-
+Branch Sub Versions
+===================
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+    :maxdepth: 2
 
+    async
+    rewrite
 
 
 Indices and tables

docs/make.bat

@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=.
 set BUILDDIR=_build
-set SPHINXPROJ=DiscordpyExamples
+set SPHINXPROJ=DiscordBotExamples
 
 if "%1" == "" goto help
 

docs/rewrite.rst

@@ -0,0 +1,16 @@
+.. currentmodule:: rewrite
+
+Rewrite Branch Examples
+=======================
+
+This is the documentation for examples that uses the rewrite branch of Discord.py.
+
+Example 1
+---------
+
+pass
+
+Example 2
+---------
+
+pass