Taylor Fox Dahlin
commited on
Documentation fix (#760)
Browse filesReplaced references to pytube3 with pytube, and hbmartin with nficano in docs
- docs/api.rst +2 -8
- docs/conf.py +8 -8
- docs/index.rst +8 -8
- docs/user/install.rst +4 -4
docs/api.rst
CHANGED
@@ -28,14 +28,14 @@ StreamQuery Object
|
|
28 |
:inherited-members:
|
29 |
|
30 |
Caption Object
|
31 |
-
|
32 |
|
33 |
.. autoclass:: pytube.Caption
|
34 |
:members:
|
35 |
:inherited-members:
|
36 |
|
37 |
CaptionQuery Object
|
38 |
-
|
39 |
|
40 |
.. autoclass:: pytube.query.CaptionQuery
|
41 |
:members:
|
@@ -59,12 +59,6 @@ Exceptions
|
|
59 |
.. automodule:: pytube.exceptions
|
60 |
:members:
|
61 |
|
62 |
-
Mixins
|
63 |
-
------
|
64 |
-
|
65 |
-
.. automodule:: pytube.mixins
|
66 |
-
:members:
|
67 |
-
|
68 |
|
69 |
Helpers
|
70 |
-------
|
|
|
28 |
:inherited-members:
|
29 |
|
30 |
Caption Object
|
31 |
+
--------------
|
32 |
|
33 |
.. autoclass:: pytube.Caption
|
34 |
:members:
|
35 |
:inherited-members:
|
36 |
|
37 |
CaptionQuery Object
|
38 |
+
-------------------
|
39 |
|
40 |
.. autoclass:: pytube.query.CaptionQuery
|
41 |
:members:
|
|
|
59 |
.. automodule:: pytube.exceptions
|
60 |
:members:
|
61 |
|
|
|
|
|
|
|
|
|
|
|
|
|
62 |
|
63 |
Helpers
|
64 |
-------
|
docs/conf.py
CHANGED
@@ -35,7 +35,7 @@ source_suffix = ".rst"
|
|
35 |
master_doc = "index"
|
36 |
|
37 |
# General information about the project.
|
38 |
-
project = "
|
39 |
copyright = "2019, Nick Ficano" # noqa: A001
|
40 |
author = "Nick Ficano, Harold Martin"
|
41 |
|
@@ -107,7 +107,7 @@ html_sidebars = {
|
|
107 |
# -- Options for HTMLHelp output ------------------------------------------
|
108 |
|
109 |
# Output file base name for HTML help builder.
|
110 |
-
htmlhelp_basename = "
|
111 |
|
112 |
# -- Options for LaTeX output ---------------------------------------------
|
113 |
|
@@ -119,8 +119,8 @@ latex_elements = {}
|
|
119 |
latex_documents = [
|
120 |
(
|
121 |
master_doc,
|
122 |
-
"
|
123 |
-
"
|
124 |
"Nick Ficano",
|
125 |
"manual",
|
126 |
),
|
@@ -131,7 +131,7 @@ latex_documents = [
|
|
131 |
# One entry per manual page. List of tuples
|
132 |
# (source start file, name, description, authors, manual section).
|
133 |
man_pages = [
|
134 |
-
(master_doc, "
|
135 |
]
|
136 |
|
137 |
# -- Options for Texinfo output -------------------------------------------
|
@@ -142,10 +142,10 @@ man_pages = [
|
|
142 |
texinfo_documents = [
|
143 |
(
|
144 |
master_doc,
|
145 |
-
"
|
146 |
-
"
|
147 |
author,
|
148 |
-
"
|
149 |
"One line description of project.",
|
150 |
"Miscellaneous",
|
151 |
),
|
|
|
35 |
master_doc = "index"
|
36 |
|
37 |
# General information about the project.
|
38 |
+
project = "pytube"
|
39 |
copyright = "2019, Nick Ficano" # noqa: A001
|
40 |
author = "Nick Ficano, Harold Martin"
|
41 |
|
|
|
107 |
# -- Options for HTMLHelp output ------------------------------------------
|
108 |
|
109 |
# Output file base name for HTML help builder.
|
110 |
+
htmlhelp_basename = "pytubedoc"
|
111 |
|
112 |
# -- Options for LaTeX output ---------------------------------------------
|
113 |
|
|
|
119 |
latex_documents = [
|
120 |
(
|
121 |
master_doc,
|
122 |
+
"pytube.tex",
|
123 |
+
"pytube Documentation",
|
124 |
"Nick Ficano",
|
125 |
"manual",
|
126 |
),
|
|
|
131 |
# One entry per manual page. List of tuples
|
132 |
# (source start file, name, description, authors, manual section).
|
133 |
man_pages = [
|
134 |
+
(master_doc, "pytube", "pytube Documentation", [author], 1,),
|
135 |
]
|
136 |
|
137 |
# -- Options for Texinfo output -------------------------------------------
|
|
|
142 |
texinfo_documents = [
|
143 |
(
|
144 |
master_doc,
|
145 |
+
"pytube",
|
146 |
+
"pytube Documentation",
|
147 |
author,
|
148 |
+
"pytube",
|
149 |
"One line description of project.",
|
150 |
"Miscellaneous",
|
151 |
),
|
docs/index.rst
CHANGED
@@ -1,24 +1,24 @@
|
|
1 |
-
..
|
2 |
|
3 |
-
|
4 |
======
|
5 |
Release v\ |version|. (:ref:`Installation <install>`)
|
6 |
|
7 |
-
.. image:: https://img.shields.io/pypi/v/
|
8 |
:alt: Pypi
|
9 |
-
:target: https://pypi.python.org/pypi/
|
10 |
|
11 |
-
.. image:: https://travis-ci.org/
|
12 |
:alt: Build status
|
13 |
-
:target: https://travis-ci.org/
|
14 |
|
15 |
.. image:: https://coveralls.io/repos/github/nficano/pytube/badge.svg?branch=master
|
16 |
:alt: Coverage
|
17 |
:target: https://coveralls.io/github/nficano/pytube?branch=master
|
18 |
|
19 |
-
.. image:: https://img.shields.io/pypi/pyversions/
|
20 |
:alt: Python Versions
|
21 |
-
:target: https://pypi.python.org/pypi/
|
22 |
|
23 |
**pytube** is a lightweight, Pythonic, dependency-free, library (and command-line utility) for downloading YouTube Videos.
|
24 |
|
|
|
1 |
+
.. pytube documentation master file, created by sphinx-quickstart on Mon Oct 9 02:11:41 2017.
|
2 |
|
3 |
+
pytube
|
4 |
======
|
5 |
Release v\ |version|. (:ref:`Installation <install>`)
|
6 |
|
7 |
+
.. image:: https://img.shields.io/pypi/v/pytube.svg
|
8 |
:alt: Pypi
|
9 |
+
:target: https://pypi.python.org/pypi/pytube/
|
10 |
|
11 |
+
.. image:: https://travis-ci.org/nficano/pytube.svg?branch=master
|
12 |
:alt: Build status
|
13 |
+
:target: https://travis-ci.org/nficano/pytube
|
14 |
|
15 |
.. image:: https://coveralls.io/repos/github/nficano/pytube/badge.svg?branch=master
|
16 |
:alt: Coverage
|
17 |
:target: https://coveralls.io/github/nficano/pytube?branch=master
|
18 |
|
19 |
+
.. image:: https://img.shields.io/pypi/pyversions/pytube.svg
|
20 |
:alt: Python Versions
|
21 |
+
:target: https://pypi.python.org/pypi/pytube/
|
22 |
|
23 |
**pytube** is a lightweight, Pythonic, dependency-free, library (and command-line utility) for downloading YouTube Videos.
|
24 |
|
docs/user/install.rst
CHANGED
@@ -7,20 +7,20 @@ This part of the documentation covers the installation of pytube.
|
|
7 |
|
8 |
To install pytube, run the following command in your terminal::
|
9 |
|
10 |
-
$ pip install
|
11 |
|
12 |
Get the Source Code
|
13 |
-------------------
|
14 |
|
15 |
-
pytube is actively developed on GitHub, where the source is `available <https://github.com/
|
16 |
|
17 |
You can either clone the public repository::
|
18 |
|
19 |
$ git clone git://github.com/nficano/pytube.git
|
20 |
|
21 |
-
Or, download the `tarball <https://github.com/
|
22 |
|
23 |
-
$ curl -OL https://github.com/
|
24 |
# optionally, zipball is also available (for Windows users).
|
25 |
|
26 |
Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages by running::
|
|
|
7 |
|
8 |
To install pytube, run the following command in your terminal::
|
9 |
|
10 |
+
$ pip install pytube
|
11 |
|
12 |
Get the Source Code
|
13 |
-------------------
|
14 |
|
15 |
+
pytube is actively developed on GitHub, where the source is `available <https://github.com/nficano/pytube>`_.
|
16 |
|
17 |
You can either clone the public repository::
|
18 |
|
19 |
$ git clone git://github.com/nficano/pytube.git
|
20 |
|
21 |
+
Or, download the `tarball <https://github.com/nficano/pytube/tarball/master>`_::
|
22 |
|
23 |
+
$ curl -OL https://github.com/nficano/pytube/tarball/master
|
24 |
# optionally, zipball is also available (for Windows users).
|
25 |
|
26 |
Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages by running::
|