Skip to content

Commit 275aff7

Browse files
Mukundan314Mukundan314
committed
docs: Add sphinx docs
1 parent cda494c commit 275aff7

File tree

6 files changed

+306
-1
lines changed

6 files changed

+306
-1
lines changed

‎docs/Makefile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = .
8+
BUILDDIR = _build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/conf.py

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Configuration file for the Sphinx documentation builder.
4+
#
5+
# This file does only contain a selection of the most common options. For a
6+
# full list see the documentation:
7+
# http://www.sphinx-doc.org/en/master/config
8+
9+
# -- Path setup --------------------------------------------------------------
10+
11+
# If extensions (or modules to document with autodoc) are in another directory,
12+
# add these directories to sys.path here. If the directory is relative to the
13+
# documentation root, use os.path.abspath to make it absolute, like shown here.
14+
#
15+
# import os
16+
# import sys
17+
# sys.path.insert(0, os.path.abspath('.'))
18+
19+
20+
# -- Project information -----------------------------------------------------
21+
22+
project = 'python-codeforces'
23+
copyright = '2019, Mukundan Senthil <[email protected]>'
24+
author = 'Mukundan Senthil <[email protected]>'
25+
26+
# The short X.Y version
27+
version = ''
28+
# The full version, including alpha/beta/rc tags
29+
release = '0.1.0'
30+
31+
32+
# -- General configuration ---------------------------------------------------
33+
34+
# If your documentation needs a minimal Sphinx version, state it here.
35+
#
36+
# needs_sphinx = '1.0'
37+
38+
# Add any Sphinx extension module names here, as strings. They can be
39+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40+
# ones.
41+
extensions = [
42+
'sphinx.ext.autodoc',
43+
'sphinx.ext.doctest',
44+
'sphinx.ext.coverage',
45+
'sphinx.ext.viewcode',
46+
'sphinx.ext.githubpages',
47+
]
48+
49+
# Add any paths that contain templates here, relative to this directory.
50+
templates_path = ['_templates']
51+
52+
# The suffix(es) of source filenames.
53+
# You can specify multiple suffix as a list of string:
54+
#
55+
# source_suffix = ['.rst', '.md']
56+
source_suffix = '.rst'
57+
58+
# The master toctree document.
59+
master_doc = 'index'
60+
61+
# The language for content autogenerated by Sphinx. Refer to documentation
62+
# for a list of supported languages.
63+
#
64+
# This is also used if you do content translation via gettext catalogs.
65+
# Usually you set "language" from the command line for these cases.
66+
language = None
67+
68+
# List of patterns, relative to source directory, that match files and
69+
# directories to ignore when looking for source files.
70+
# This pattern also affects html_static_path and html_extra_path.
71+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
72+
73+
# The name of the Pygments (syntax highlighting) style to use.
74+
pygments_style = None
75+
76+
77+
# -- Options for HTML output -------------------------------------------------
78+
79+
# The theme to use for HTML and HTML Help pages. See the documentation for
80+
# a list of builtin themes.
81+
#
82+
html_theme = 'sphinx_rtd_theme'
83+
84+
# Theme options are theme-specific and customize the look and feel of a theme
85+
# further. For a list of options available for each theme, see the
86+
# documentation.
87+
#
88+
# html_theme_options = {}
89+
90+
# Add any paths that contain custom static files (such as style sheets) here,
91+
# relative to this directory. They are copied after the builtin static files,
92+
# so a file named "default.css" will overwrite the builtin "default.css".
93+
html_static_path = ['_static']
94+
95+
# Custom sidebar templates, must be a dictionary that maps document names
96+
# to template names.
97+
#
98+
# The default sidebars (for documents that don't match any pattern) are
99+
# defined by theme itself. Builtin themes are using these templates by
100+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
101+
# 'searchbox.html']``.
102+
#
103+
# html_sidebars = {}
104+
105+
106+
# -- Options for HTMLHelp output ---------------------------------------------
107+
108+
# Output file base name for HTML help builder.
109+
htmlhelp_basename = 'python-codeforcesdoc'
110+
111+
112+
# -- Options for LaTeX output ------------------------------------------------
113+
114+
latex_elements = {
115+
# The paper size ('letterpaper' or 'a4paper').
116+
#
117+
# 'papersize': 'letterpaper',
118+
119+
# The font size ('10pt', '11pt' or '12pt').
120+
#
121+
# 'pointsize': '10pt',
122+
123+
# Additional stuff for the LaTeX preamble.
124+
#
125+
# 'preamble': '',
126+
127+
# Latex figure (float) alignment
128+
#
129+
# 'figure_align': 'htbp',
130+
}
131+
132+
# Grouping the document tree into LaTeX files. List of tuples
133+
# (source start file, target name, title,
134+
# author, documentclass [howto, manual, or own class]).
135+
latex_documents = [
136+
(master_doc, 'python-codeforces.tex', 'python-codeforces Documentation',
137+
'Mukundan Senthil \\textless{}[email protected]\\textgreater{}', 'manual'),
138+
]
139+
140+
141+
# -- Options for manual page output ------------------------------------------
142+
143+
# One entry per manual page. List of tuples
144+
# (source start file, name, description, authors, manual section).
145+
man_pages = [
146+
(master_doc, 'python-codeforces', 'python-codeforces Documentation',
147+
[author], 1)
148+
]
149+
150+
151+
# -- Options for Texinfo output ----------------------------------------------
152+
153+
# Grouping the document tree into Texinfo files. List of tuples
154+
# (source start file, target name, title, author,
155+
# dir menu entry, description, category)
156+
texinfo_documents = [
157+
(master_doc, 'python-codeforces', 'python-codeforces Documentation',
158+
author, 'python-codeforces', 'One line description of project.',
159+
'Miscellaneous'),
160+
]
161+
162+
163+
# -- Options for Epub output -------------------------------------------------
164+
165+
# Bibliographic Dublin Core info.
166+
epub_title = project
167+
168+
# The unique identifier of the text. This can be a ISBN number
169+
# or the project homepage.
170+
#
171+
# epub_identifier = ''
172+
173+
# A unique identification for the text.
174+
#
175+
# epub_uid = ''
176+
177+
# A list of files that should not be packed into the epub file.
178+
epub_exclude_files = ['search.html']
179+
180+
181+
# -- Extension configuration -------------------------------------------------

‎docs/index.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. python-codeforces documentation master file, created by
2+
sphinx-quickstart on Sun Jan 13 09:21:55 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to python-codeforces's documentation!
7+
=============================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
usage/quickstart
14+
15+
16+
Indices and tables
17+
==================
18+
19+
* :ref:`genindex`
20+
* :ref:`modindex`
21+
* :ref:`search`

‎docs/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33+
34+
:end
35+
popd

‎docs/usage/quickstart.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Quickstart
2+
==========
3+
4+
Installation
5+
------------
6+
7+
python-codeforces can be installed using ``pip`` as follows:
8+
9+
.. code-block:: shell
10+
11+
pip install python-codeforces
12+
13+
Installation from source can be done from the root of the project with
14+
the following command.
15+
16+
.. code-block:: shell
17+
18+
pip install .
19+
20+
Using python-codeforces
21+
-----------------------
22+
23+
Introduction
24+
^^^^^^^^^^^^
25+
26+
Direct `API <https://codeforces.com/api/help>`_ calls can be made with the ``codeforces.api.call`` function. For Example:
27+
28+
.. code-block:: python
29+
30+
>>> from codeforces import api
31+
>>> api.call('user.info', handles="mukundan314")
32+
[{'lastName': 'Senthil', 'country': 'India', 'lastOnlineTimeSeconds': 1547349164, 'city': 'Coimbatore', 'rating': 1495, 'friendOfCount': 4, 'titlePhoto': '//userpic.codeforces.com/765517/title/93ffab462a95eb16.jpg', 'handle': 'Mukundan314', 'avatar': '//userpic.codeforces.com/765517/avatar/b0cea461ab905c83.jpg', 'firstName': 'Mukundan', 'contribution': 0, 'organization': 'Block Lab', 'rank': 'specialist', 'maxRating': 1502, 'registrationTimeSeconds': 1531657670, 'email': '[email protected]', 'maxRank': 'specialist'}]
33+
34+
Authorization
35+
^^^^^^^^^^^^^
36+
37+
To make authorized API calls you need to generate a API key at https://codeforces.com/settings/api.
38+
39+
And when making authorized call:
40+
41+
.. code-block:: python
42+
43+
from codeforces import api
44+
45+
api_key = "xxx"
46+
api_secret = "yyy"
47+
48+
api.call("method_name", key=api_key, secret=api_secret, arg=arg_for_method)

‎setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@
1515
license='MIT',
1616
keywords='codeforces',
1717
url='https://github.com/Mukundan314/python-codeforces',
18-
packages=find_packages()
18+
extras_requires={ 'docs': ['sphinx', 'sphinx_rtd_theme'] },
19+
packages=find_packages(exclude=['docs'])
1920
)

0 commit comments

Comments
 (0)