Deployed 398ecf9 with MkDocs version: 1.0.4

This commit is contained in:
Christian Schabesberger 2018-11-14 10:19:30 +01:00
parent f1389fdcc8
commit 6523757102
7 changed files with 22 additions and 17 deletions

View File

@ -137,9 +137,14 @@
<div class="section"> <div class="section">
<h1 id="prepare-everything">Prepare everything</h1> <h1 id="prepare-everything">Prepare everything</h1>
<p>Welcome to the NewPipe tutorial. This tutorial will guide you through the process of creating your own NewPipeExtractor <p>Welcome to the NewPipeExtractor documentation. This tutorial will guide you through the process of creating your own Extractor
service with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SoundCloud. Let's service with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SoundCloud.
dive right in. ;D</p> The whole documentation consists of this page, which explains the general concept of the NewPipeExtractor, as well as our
<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/">Jdoc</a> setup.</p>
<p><strong>IMPORTANT!!!</strong> this is likely to be the worst documentation you have ever red, so do not hesitate to
<a href="https://github.com/teamnewpipe/documentation/issues">report</a> if
you find any (spelling)errors, incomplete parts or you simply don't understand something. We are an open community
and are open for everyone to help :)</p>
<h2 id="setup-your-dev-environment">Setup your dev environment</h2> <h2 id="setup-your-dev-environment">Setup your dev environment</h2>
<p>First and foremost you need to meet certain conditions in order to write your own service.</p> <p>First and foremost you need to meet certain conditions in order to write your own service.</p>
<h3 id="what-you-need-to-know">What you need to know</h3> <h3 id="what-you-need-to-know">What you need to know</h3>
@ -172,7 +177,7 @@ If all the checks are green you did everything right, and you are good to go to
<h4 id="running-test-in-android-studio">Running test in Android Studio</h4> <h4 id="running-test-in-android-studio">Running test in Android Studio</h4>
<p>Go to <em>run</em> &gt; <em>edit configurations</em> &gt; <em>add new configuration</em> and select "Gradle". <p>Go to <em>run</em> &gt; <em>edit configurations</em> &gt; <em>add new configuration</em> and select "Gradle".
As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run.</p> As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run.</p>
<p><img alt="tests passed on idea" src="../img/prepare_tests_passed.png" /></p> <p><img alt="tests passed on idea" src="/img/prepare_tests_passed.png" /></p>
<h1 id="inclusion-criteria-for-services">Inclusion criteria for services</h1> <h1 id="inclusion-criteria-for-services">Inclusion criteria for services</h1>
<p>After creating you own service you will need to submit it to our <a href="https://github.com/teamnewpipe/newpipeextractor">NewPipeExtractor</a> <p>After creating you own service you will need to submit it to our <a href="https://github.com/teamnewpipe/newpipeextractor">NewPipeExtractor</a>
repository. However in order to include your changes you need to follow these rules:</p> repository. However in order to include your changes you need to follow these rules:</p>

View File

@ -182,7 +182,7 @@ try {
<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItemsCollector.html">InfoItemsCollector</a>. <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItemsCollector.html">InfoItemsCollector</a>.
A InfoItemCollector will collect and assemble a list of <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItem.html">InfoItem</a>. A InfoItemCollector will collect and assemble a list of <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItem.html">InfoItem</a>.
For each item that should be extracted a new Extractor must be created, and given to the InfoItemCollector via <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItemsCollector.html#commit-E-">commit()</a>.</p> For each item that should be extracted a new Extractor must be created, and given to the InfoItemCollector via <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItemsCollector.html#commit-E-">commit()</a>.</p>
<p><img alt="InfoItemsCollector_objectdiagram.svg" src="../img/InfoItemsCollector_objectdiagram.svg" /></p> <p><img alt="InfoItemsCollector_objectdiagram.svg" src="/img/InfoItemsCollector_objectdiagram.svg" /></p>
<p>If you are implementing a list for your service you need to extend InfoItem containing the extracted information, <p>If you are implementing a list for your service you need to extend InfoItem containing the extracted information,
and implement an <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Extractor.html">InfoItemExtractor</a> and implement an <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Extractor.html">InfoItemExtractor</a>
that will return the data of one InfoItem.</p> that will return the data of one InfoItem.</p>

View File

@ -134,7 +134,7 @@
<h1 id="run-the-changes-in-the-app">Run the changes in the App</h1> <h1 id="run-the-changes-in-the-app">Run the changes in the App</h1>
<p>You should develop and test your changes with the JUnit environment that is <p>You should develop and test your changes with the JUnit environment that is
provided by the NewPipe Extractor and IDEA. If you want to try it then with provided by the NewPipe Extractor and IDEA. If you want to try it then with
the actual fronted you need to follow these changes.</p> the actual fronted you need to follow these steps.</p>
<h3 id="setup-android-studio">Setup Android Studio</h3> <h3 id="setup-android-studio">Setup Android Studio</h3>
<p>First of all you want to setup a working Android Studio environment. For this please <p>First of all you want to setup a working Android Studio environment. For this please
download Studio from <a href="https://developer.android.com/studio/">developer.android.com</a>, download Studio from <a href="https://developer.android.com/studio/">developer.android.com</a>,
@ -164,11 +164,11 @@ Your browser does not support the video tag.
<p>If everything synced well then you should only see a screen with OK signs. Now you can go on an compile and run NewPipe <p>If everything synced well then you should only see a screen with OK signs. Now you can go on an compile and run NewPipe
with the new extractor. with the new extractor.
<img alt="image_sync_ok" src="../img/sync_ok.png" /></p> <img alt="image_sync_ok" src="/img/sync_ok.png" /></p>
<h3 id="trouble-shoot">Trouble shoot</h3> <h3 id="trouble-shoot">Trouble shoot</h3>
<p>If something went wrong on jitpack site, you can check their build log, by selecting the commit you tried to build and <p>If something went wrong on jitpack site, you can check their build log, by selecting the commit you tried to build and
click on that little paper symbol next to the <code>GET IT</code> button. If it is red it already shows that the build failed. click on that little paper symbol next to the <code>GET IT</code> button. If it is red it already shows that the build failed.
<img alt="jitpack failed to build" src="../img/jitpack_fail.png" /></p> <img alt="jitpack failed to build" src="/img/jitpack_fail.png" /></p>
</div> </div>
</div> </div>

View File

@ -180,6 +180,6 @@ It focuses on making it possible for the creator of a scraper for a streaming se
</html> </html>
<!-- <!--
MkDocs version : 1.0.3 MkDocs version : 1.0.4
Build Date UTC : 2018-11-03 16:03:44 Build Date UTC : 2018-11-14 09:19:30
--> -->

File diff suppressed because one or more lines are too long

View File

@ -2,32 +2,32 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2018-11-03</lastmod> <lastmod>2018-11-14</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2018-11-03</lastmod> <lastmod>2018-11-14</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2018-11-03</lastmod> <lastmod>2018-11-14</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2018-11-03</lastmod> <lastmod>2018-11-14</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2018-11-03</lastmod> <lastmod>2018-11-14</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2018-11-03</lastmod> <lastmod>2018-11-14</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
</urlset> </urlset>

Binary file not shown.