Skip to content

Commit a3a673d

Browse files
authored
Add docs (#129)
* Add docs via sphinx * Fix some VkApi docstings * Update VkApi method names
1 parent 9121047 commit a3a673d

32 files changed

Lines changed: 807 additions & 354 deletions

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
11
.idea/
22
.vscode/
3+
34
build/
45
dist/
56
*.pyc
7+
8+
env/
9+
venv/
10+
611
MANIFEST
12+
13+
.pytest_cache/
714
.project
815
.pydevproject
916
.settings/
17+
1018
testing/
1119
tests1/
20+
1221
vk_config.json
1322
vk_config.v2.json
23+
24+
docs/_build/

doc/VkApi.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

doc/VkTools.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

doc/VkUpload.md

Lines changed: 0 additions & 76 deletions
This file was deleted.

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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+
SPHINXPROJ = vk_api
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/css/custom.css

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.logo {
2+
font-family: "Courier New", Courier, "Liberation Mono", "Anonymous Pro", monospace;
3+
}

docs/audio.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
VkAudio
2+
=======
3+
4+
Модуль для работы с аудио
5+
6+
.. module:: vk_api.audio
7+
.. autoclass:: VkAudio
8+
:members:

0 commit comments

Comments
 (0)