diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..c647eb13 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Pyrogram +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..fea543e2 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=Pyrogram + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/source/_static/pyrogram.ico b/docs/source/_static/pyrogram.ico new file mode 100644 index 00000000..4165f9ed Binary files /dev/null and b/docs/source/_static/pyrogram.ico differ diff --git a/docs/source/_static/pyrogram.png b/docs/source/_static/pyrogram.png new file mode 100644 index 00000000..1f06fa81 Binary files /dev/null and b/docs/source/_static/pyrogram.png differ diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..0f3cf1bd --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,183 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Pyrogram documentation build configuration file, created by +# sphinx-quickstart on Fri Dec 29 11:35:55 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# 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 after sys.path.insert() to avoid issues +from pyrogram import __version__ + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon' +] + +# Order by source, not alphabetically +autodoc_member_order = 'bysource' + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Pyrogram' +copyright = '2017, Dan Tès' +author = 'Dan Tès' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = "version " + __version__ +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +html_theme_options = { + 'collapse_navigation': False +} + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '_static/pyrogram.png' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '_static/pyrogram.ico' + +# 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". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Pyrogramdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Pyrogram.tex', 'Pyrogram Documentation', + 'Dan Tès', 'manual'), +] + +# -- 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, 'pyrogram', 'Pyrogram Documentation', + [author], 1) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Pyrogram', 'Pyrogram Documentation', + author, 'Pyrogram', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/source/errors/303_see_other.rst b/docs/source/errors/303_see_other.rst new file mode 100644 index 00000000..6d2875c3 --- /dev/null +++ b/docs/source/errors/303_see_other.rst @@ -0,0 +1,6 @@ +See Other +========= + +.. automodule:: pyrogram.api.errors.exceptions.see_other_303 + :members: + :show-inheritance: diff --git a/docs/source/errors/400_bad_request.rst b/docs/source/errors/400_bad_request.rst new file mode 100644 index 00000000..f10b70dc --- /dev/null +++ b/docs/source/errors/400_bad_request.rst @@ -0,0 +1,6 @@ +Bad Request +=========== + +.. automodule:: pyrogram.api.errors.exceptions.bad_request_400 + :members: + :show-inheritance: diff --git a/docs/source/errors/401_unauthorized.rst b/docs/source/errors/401_unauthorized.rst new file mode 100644 index 00000000..ef73e75b --- /dev/null +++ b/docs/source/errors/401_unauthorized.rst @@ -0,0 +1,6 @@ +Unauthorized +============ + +.. automodule:: pyrogram.api.errors.exceptions.unauthorized_401 + :members: + :show-inheritance: diff --git a/docs/source/errors/420_flood.rst b/docs/source/errors/420_flood.rst new file mode 100644 index 00000000..89b3b713 --- /dev/null +++ b/docs/source/errors/420_flood.rst @@ -0,0 +1,6 @@ +Flood +===== + +.. automodule:: pyrogram.api.errors.exceptions.flood_420 + :members: + :show-inheritance: diff --git a/docs/source/errors/500_internal_server_error.rst b/docs/source/errors/500_internal_server_error.rst new file mode 100644 index 00000000..5fdb1d48 --- /dev/null +++ b/docs/source/errors/500_internal_server_error.rst @@ -0,0 +1,6 @@ +Internal Server Error +===================== + +.. automodule:: pyrogram.api.errors.exceptions.internal_server_error_500 + :members: + :show-inheritance: diff --git a/docs/source/errors/520_unknown_error.rst b/docs/source/errors/520_unknown_error.rst new file mode 100644 index 00000000..e617777d --- /dev/null +++ b/docs/source/errors/520_unknown_error.rst @@ -0,0 +1,6 @@ +Unknown Error +============= + +.. autoclass:: pyrogram.api.errors.error.UnknownError + :members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..b736635c --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,26 @@ +Welcome to Pyrogram +=================== + +.. raw:: html + +

+ +
Pyrogram Icon
+ +

+ +Welcome to Pyrogram's documentation. Here you can find a detailed description of the Pyrogram API. +You will notice that methods are named after the well established `Telegram Bot API`_ and that most of them +accept the same parameters as well. + +.. note:: + This document is intended to be used as an API reference documentation. + For more information on how to install and setup the library, please refer to the Wiki_. + +.. toctree:: + pyrogram + :caption: Documentation + +.. _Wiki: https://github.com/pyrogram/pyrogram/wiki + +.. _`Telegram Bot API`: https://core.telegram.org/bots/api#available-methods \ No newline at end of file diff --git a/docs/source/pyrogram.ChatAction.rst b/docs/source/pyrogram.ChatAction.rst new file mode 100644 index 00000000..750c725f --- /dev/null +++ b/docs/source/pyrogram.ChatAction.rst @@ -0,0 +1,6 @@ +pyrogram.ChatAction +=================== + +.. autoclass:: pyrogram.ChatAction + :members: + :undoc-members: diff --git a/docs/source/pyrogram.Client.rst b/docs/source/pyrogram.Client.rst new file mode 100644 index 00000000..a7e395f5 --- /dev/null +++ b/docs/source/pyrogram.Client.rst @@ -0,0 +1,5 @@ +pyrogram.Client +=============== + +.. autoclass:: pyrogram.Client + :members: diff --git a/docs/source/pyrogram.Error.rst b/docs/source/pyrogram.Error.rst new file mode 100644 index 00000000..57529f8b --- /dev/null +++ b/docs/source/pyrogram.Error.rst @@ -0,0 +1,14 @@ +pyrogram.Error +=============== + +.. autoclass:: pyrogram.Error + :members: + :show-inheritance: + +.. toctree:: + errors/303_see_other + errors/400_bad_request + errors/401_unauthorized + errors/420_flood + errors/500_internal_server_error + errors/520_unknown_error diff --git a/docs/source/pyrogram.rst b/docs/source/pyrogram.rst new file mode 100644 index 00000000..fdeafee4 --- /dev/null +++ b/docs/source/pyrogram.rst @@ -0,0 +1,7 @@ +Pyrogram Package +================ + +.. toctree:: + pyrogram.Client + pyrogram.ChatAction + pyrogram.Error