updated docs
Browse files- docs/conf.py +7 -40
- docs/user/quickstart.rst +8 -0
docs/conf.py
CHANGED
@@ -1,33 +1,16 @@
|
|
1 |
#!/usr/bin/env python3
|
2 |
# -*- coding: utf-8 -*-
|
3 |
"""pytube documentation build configuration file."""
|
4 |
-
#
|
5 |
-
#
|
6 |
-
#
|
7 |
-
# This file is execfile()d with the current directory set to its
|
8 |
-
# containing dir.
|
9 |
-
#
|
10 |
-
# Note that not all possible configuration values are present in this
|
11 |
-
# autogenerated file.
|
12 |
-
#
|
13 |
-
# All configuration values have a default; values that are commented out
|
14 |
-
# serve to show the default.
|
15 |
-
# If extensions (or modules to document with autodoc) are in another directory,
|
16 |
-
# add these directories to sys.path here. If the directory is relative to the
|
17 |
-
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
18 |
import os
|
19 |
import sys
|
20 |
|
21 |
import sphinx_rtd_theme
|
22 |
-
|
23 |
sys.path.insert(0, os.path.abspath('../'))
|
|
|
|
|
|
|
24 |
# -- General configuration ------------------------------------------------
|
25 |
-
|
26 |
-
#
|
27 |
-
# needs_sphinx = '1.0'
|
28 |
-
# Add any Sphinx extension module names here, as strings. They can be
|
29 |
-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
30 |
-
# ones.
|
31 |
extensions = [
|
32 |
'sphinx.ext.autodoc',
|
33 |
'sphinx.ext.autosummary',
|
@@ -60,9 +43,9 @@ author = 'Nick Ficano'
|
|
60 |
# built documents.
|
61 |
#
|
62 |
# The short X.Y version.
|
63 |
-
version =
|
64 |
# The full version, including alpha/beta/rc tags.
|
65 |
-
release =
|
66 |
|
67 |
# The language for content autogenerated by Sphinx. Refer to documentation
|
68 |
# for a list of supported languages.
|
@@ -130,23 +113,7 @@ htmlhelp_basename = 'pytubedoc'
|
|
130 |
|
131 |
# -- Options for LaTeX output ---------------------------------------------
|
132 |
|
133 |
-
latex_elements = {
|
134 |
-
# The paper size ('letterpaper' or 'a4paper').
|
135 |
-
#
|
136 |
-
# 'papersize': 'letterpaper',
|
137 |
-
|
138 |
-
# The font size ('10pt', '11pt' or '12pt').
|
139 |
-
#
|
140 |
-
# 'pointsize': '10pt',
|
141 |
-
|
142 |
-
# Additional stuff for the LaTeX preamble.
|
143 |
-
#
|
144 |
-
# 'preamble': '',
|
145 |
-
|
146 |
-
# Latex figure (float) alignment
|
147 |
-
#
|
148 |
-
# 'figure_align': 'htbp',
|
149 |
-
}
|
150 |
|
151 |
# Grouping the document tree into LaTeX files. List of tuples
|
152 |
# (source start file, target name, title,
|
|
|
1 |
#!/usr/bin/env python3
|
2 |
# -*- coding: utf-8 -*-
|
3 |
"""pytube documentation build configuration file."""
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4 |
import os
|
5 |
import sys
|
6 |
|
7 |
import sphinx_rtd_theme
|
|
|
8 |
sys.path.insert(0, os.path.abspath('../'))
|
9 |
+
|
10 |
+
from pytube import __version__ # noqa
|
11 |
+
|
12 |
# -- General configuration ------------------------------------------------
|
13 |
+
|
|
|
|
|
|
|
|
|
|
|
14 |
extensions = [
|
15 |
'sphinx.ext.autodoc',
|
16 |
'sphinx.ext.autosummary',
|
|
|
43 |
# built documents.
|
44 |
#
|
45 |
# The short X.Y version.
|
46 |
+
version = __version__
|
47 |
# The full version, including alpha/beta/rc tags.
|
48 |
+
release = __version__
|
49 |
|
50 |
# The language for content autogenerated by Sphinx. Refer to documentation
|
51 |
# for a list of supported languages.
|
|
|
113 |
|
114 |
# -- Options for LaTeX output ---------------------------------------------
|
115 |
|
116 |
+
latex_elements = {}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
117 |
|
118 |
# Grouping the document tree into LaTeX files. List of tuples
|
119 |
# (source start file, target name, title,
|
docs/user/quickstart.rst
ADDED
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
.. _quickstart:
|
2 |
+
|
3 |
+
Quickstart
|
4 |
+
==========
|
5 |
+
|
6 |
+
This guide will walk you through the basic usage of pytube.
|
7 |
+
|
8 |
+
Let's get started with some simple examples.
|