aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2015-08-22 07:32:28 -0400
committerRapptz <[email protected]>2015-08-22 07:43:41 -0400
commit44953e7a3ffed1e5ad5ee1e5eead6b059615d401 (patch)
tree9b110f53f3cf6649a8a530b12eef19576b0b481c /docs
parentSome documentation warning fixes. (diff)
downloaddiscord.py-44953e7a3ffed1e5ad5ee1e5eead6b059615d401.tar.xz
discord.py-44953e7a3ffed1e5ad5ee1e5eead6b059615d401.zip
Rename project from pydiscord to discord.py
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile8
-rw-r--r--docs/api.rst2
-rw-r--r--docs/conf.py14
-rw-r--r--docs/index.rst6
-rw-r--r--docs/make.bat4
5 files changed, 17 insertions, 17 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 42691163..05ff4d93 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -86,17 +86,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pydiscord.qhcp"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/discord.py.qhcp"
@echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pydiscord.qhc"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/discord.py.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/pydiscord"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pydiscord"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/discord.py"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/discord.py"
@echo "# devhelp"
epub:
diff --git a/docs/api.rst b/docs/api.rst
index dcfc8bbf..937eff70 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -3,7 +3,7 @@
API Reference
===============
-The following section outlines the API of pydiscord.
+The following section outlines the API of discord.py.
Client
diff --git a/docs/conf.py b/docs/conf.py
index f47a0f62..2c784de4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
-# pydiscord documentation build configuration file, created by
+# discord.py documentation build configuration file, created by
# sphinx-quickstart on Fri Aug 21 05:43:30 2015.
#
# This file is execfile()d with the current directory set to its
@@ -45,7 +45,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'pydiscord'
+project = u'discord.py'
copyright = u'2015, Rapptz'
# The version info for the project you're documenting, acts as replacement for
@@ -197,7 +197,7 @@ html_static_path = ['_static']
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
-htmlhelp_basename = 'pydiscorddoc'
+htmlhelp_basename = 'discord.pydoc'
# -- Options for LaTeX output ---------------------------------------------
@@ -219,7 +219,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- ('index', 'pydiscord.tex', u'pydiscord Documentation',
+ ('index', 'discord.py.tex', u'discord.py Documentation',
u'Rapptz', 'manual'),
]
@@ -249,7 +249,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'pydiscord', u'pydiscord Documentation',
+ ('index', 'discord.py', u'discord.py Documentation',
[u'Rapptz'], 1)
]
@@ -263,8 +263,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- ('index', 'pydiscord', u'pydiscord Documentation',
- u'Rapptz', 'pydiscord', 'One line description of project.',
+ ('index', 'discord.py', u'discord.py Documentation',
+ u'Rapptz', 'discord.py', 'One line description of project.',
'Miscellaneous'),
]
diff --git a/docs/index.rst b/docs/index.rst
index e74189d8..2e0d878d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,10 +1,10 @@
-.. pydiscord documentation master file, created by
+.. discord.py documentation master file, created by
sphinx-quickstart on Fri Aug 21 05:43:30 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to pydiscord's documentation!
-=====================================
+Welcome to discord.py's documentation!
+======================================
Contents:
diff --git a/docs/make.bat b/docs/make.bat
index f04b4b55..bb9b6353 100644
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -127,9 +127,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pydiscord.qhcp
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\discord.py.qhcp
echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pydiscord.ghc
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\discord.py.ghc
goto end
)