be-gay-do-crimes
/
newpipe-documentation
mirror of https://github.com/TeamNewPipe/documentation
1
0
Fork 0
Code Issues Releases Wiki Activity

Deployed fc3ea01 with MkDocs version: 1.1.2

This commit is contained in:
TobiGr 2020-08-13 01:02:52 +01:00
parent 7e61132943
commit abfc6b4d3a
50 changed files with 4017 additions and 1496 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
00_Prepare_everything/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>Before You Start - NewPipe Documentation</title> <title>Before You Start - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,80 +51,58 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
</li>
</ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Before You Start</a>
<ul class="current">
<li class="toctree-l1"> <li class="toctree-l2"><a class="reference internal" href="#setting-up-your-dev-environment">Setting Up Your Dev Environment</a>
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">Before You Start</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#before-you-start">Before You Start</a></li>
<ul> <ul>
<li class="toctree-l3"><a class="reference internal" href="#what-you-need-to-know">What You Need to Know:</a>
<li><a class="toctree-l3" href="#setting-up-your-dev-environment">Setting Up Your Dev Environment</a></li> </li>
<li class="toctree-l3"><a class="reference internal" href="#toolsprograms-you-will-need">Tools/Programs You Will Need:</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#importing-the-newpipe-extractor-in-intellij-idea">Importing the NewPipe Extractor in IntelliJ IDEA</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#running-test-in-android-studiointellij-idea">Running "test" in Android Studio/IntelliJ IDEA</a>
</li>
</ul>
</li>
</ul>
</li>
</ul> </ul>
<li class="toctree-l2"><a href="#inclusion-criteria-for-services">Inclusion Criteria for Services</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
<li><a class="toctree-l3" href="#content-that-is-permitted">Content That is Permitted</a></li> </li>
<li><a class="toctree-l3" href="#content-that-is-not-permitted">Content That is NOT Permitted</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a>
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a>
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a>
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
<li class="toctree-l1">
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li>
<li class="toctree-l1">
<a class="" href="../06_documentation/">About This Documentation</a>
</li>
<li class="toctree-l1">
<a class="" href="../07_maintainers_view/">Maintainers' Section</a>
</li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -147,6 +127,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -247,7 +228,7 @@ As Gradle Project, select NewPipeExtractor. As a task, add "test". Now save and
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -257,7 +238,7 @@ As Gradle Project, select NewPipeExtractor. As a task, add "test". Now save and
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -271,6 +252,11 @@ As Gradle Project, select NewPipeExtractor. As a task, add "test". Now save and
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

107
01_Concept_of_the_extractor/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>Concept of the Extractor - NewPipe Documentation</title> <title>Concept of the Extractor - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,73 +51,58 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1">
<a class="" href="../00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">Concept of the Extractor</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#concept-of-the-extractor">Concept of the Extractor</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
<li><a class="toctree-l3" href="#the-collectorextractor-pattern">The Collector/Extractor Pattern</a></li> </li>
<li><a class="toctree-l3" href="#collectorextractor-pattern-for-lists">Collector/Extractor Pattern for Lists</a></li>
<li><a class="toctree-l3" href="#listextractor">ListExtractor</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Concept of the Extractor</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#the-collectorextractor-pattern">The Collector/Extractor Pattern</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#usage-in-the-front-end">Usage in the Front End</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#typical-implementation-of-a-single-data-extractor">Typical Implementation of a Single Data Extractor</a>
</li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#collectorextractor-pattern-for-lists">Collector/Extractor Pattern for Lists</a>
<li class="toctree-l1">
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#listextractor">ListExtractor</a>
<li class="toctree-l1">
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul>
<li class="toctree-l1">
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
<a class="" href="../06_documentation/">About This Documentation</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
<a class="" href="../07_maintainers_view/">Maintainers' Section</a> </li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -140,6 +127,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -314,7 +302,7 @@ items like a regular web page, but all the others as an AJAX request.</p>
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -324,7 +312,7 @@ items like a regular web page, but all the others as an AJAX request.</p>
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -338,6 +326,11 @@ items like a regular web page, but all the others as an AJAX request.</p>
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

111
02_Concept_of_LinkHandler/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>Concept of the LinkHandler - NewPipe Documentation</title> <title>Concept of the LinkHandler - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,75 +51,58 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1">
<a class="" href="../00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1">
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">Concept of the LinkHandler</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#concept-of-the-linkhandler">Concept of the LinkHandler</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
<li><a class="toctree-l3" href="#important-notes-about-linkhandler">Important notes about LinkHandler</a></li> </li>
<li><a class="toctree-l3" href="#usage">Usage</a></li>
<li><a class="toctree-l3" href="#implementation">Implementation</a></li>
<li><a class="toctree-l3" href="#listlinkhandler-and-searchqueryhandler">ListLinkHandler and SearchQueryHandler</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Concept of the LinkHandler</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#important-notes-about-linkhandler">Important notes about LinkHandler</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#implementation">Implementation</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#listlinkhandler-and-searchqueryhandler">ListLinkHandler and SearchQueryHandler</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#searchqueryhandler">SearchQueryHandler</a>
</li>
</ul> </ul>
</li> </li>
</ul>
<li class="toctree-l1">
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a>
<a class="" href="../06_documentation/">About This Documentation</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a>
<a class="" href="../07_maintainers_view/">Maintainers' Section</a> </li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -142,6 +127,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -237,7 +223,7 @@ and <code>getId()</code> when overriding <a href="https://teamnewpipe.github.io/
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -247,7 +233,7 @@ and <code>getId()</code> when overriding <a href="https://teamnewpipe.github.io/
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -261,6 +247,11 @@ and <code>getId()</code> when overriding <a href="https://teamnewpipe.github.io/
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

129
03_Implement_a_service/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>Implementing a Service - NewPipe Documentation</title> <title>Implementing a Service - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,83 +51,66 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1">
<a class="" href="../00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1">
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
<li class="toctree-l1">
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">Implementing a Service</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#implementing-a-service">Implementing a Service</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
<li><a class="toctree-l3" href="#required-and-optional-parts">Required and Optional Parts</a></li> </li>
<li><a class="toctree-l3" href="#allowed-libraries">Allowed Libraries</a></li>
<li><a class="toctree-l3" href="#head-of-service">Head of Service</a></li>
<li><a class="toctree-l3" href="#stream">Stream</a></li>
<li><a class="toctree-l3" href="#search">Search</a></li>
<li><a class="toctree-l3" href="#playlist">Playlist</a></li>
<li><a class="toctree-l3" href="#channel">Channel</a></li>
<li><a class="toctree-l3" href="#kiosk">Kiosk</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Implementing a Service</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#required-and-optional-parts">Required and Optional Parts</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#allowed-libraries">Allowed Libraries</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#head-of-service">Head of Service</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#stream">Stream</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#search">Search</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#playlist">Playlist</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#channel">Channel</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#kiosk">Kiosk</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#multiple-kiosks">Multiple Kiosks</a>
</li>
</ul> </ul>
</li> </li>
</ul>
<li class="toctree-l1">
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a>
<a class="" href="../06_documentation/">About This Documentation</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a>
<a class="" href="../07_maintainers_view/">Maintainers' Section</a> </li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -150,6 +135,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -323,7 +309,7 @@ public KioskList getKioskList() throws ExtractionException {
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -333,7 +319,7 @@ public KioskList getKioskList() throws ExtractionException {
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -347,6 +333,11 @@ public KioskList getKioskList() throws ExtractionException {
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

117
04_Run_changes_in_App/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>Testing Your Changes in the App - NewPipe Documentation</title> <title>Testing Your Changes in the App - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,75 +51,60 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1">
<a class="" href="../00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1">
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
<li class="toctree-l1">
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
<li class="toctree-l1">
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">Testing Your Changes in the App</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#testing-your-changes-in-the-app">Testing Your Changes in the App</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
<li><a class="toctree-l3" href="#setup-android-studio">Setup Android Studio</a></li> </li>
<li><a class="toctree-l3" href="#get-the-newpipe-code-and-run-it">Get the NewPipe Code and Run it.</a></li>
<li><a class="toctree-l3" href="#run-your-changes-on-the-extractor">Run Your Changes on the Extractor</a></li>
<li><a class="toctree-l3" href="#troubleshooting">Troubleshooting</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Testing Your Changes in the App</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#setup-android-studio">Setup Android Studio</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#get-the-newpipe-code-and-run-it">Get the NewPipe Code and Run it.</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#run-your-changes-on-the-extractor">Run Your Changes on the Extractor</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#using-local-folder">Using local folder</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#using-jitpack">Using JitPack</a>
</li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a>
<li class="toctree-l1">
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul>
<li class="toctree-l1">
<a class="" href="../06_documentation/">About This Documentation</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a>
<a class="" href="../07_maintainers_view/">Maintainers' Section</a> </li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -142,6 +129,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -220,7 +208,7 @@ click on that little paper symbol next to the <code>GET IT</code> button. If it'
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -230,7 +218,7 @@ click on that little paper symbol next to the <code>GET IT</code> button. If it'
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -244,6 +232,11 @@ click on that little paper symbol next to the <code>GET IT</code> button. If it'
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

143
05_releasing/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>Releasing a New NewPipe Version - NewPipe Documentation</title> <title>Releasing a New NewPipe Version - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,77 +51,80 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1">
<a class="" href="../00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1">
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
<li class="toctree-l1">
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
<li class="toctree-l1">
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
<li class="toctree-l1">
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">Releasing a New NewPipe Version</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#releasing-a-new-newpipe-version">Releasing a New NewPipe Version</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
<li><a class="toctree-l3" href="#differences-between-regular-and-hotfix-releases">Differences Between Regular and Hotfix Releases</a></li> </li>
<li><a class="toctree-l3" href="#regular-releases">Regular Releases</a></li>
<li><a class="toctree-l3" href="#hotfix-releases">Hotfix Releases</a></li>
<li><a class="toctree-l3" href="#version-nomenclature">Version Nomenclature</a></li>
<li><a class="toctree-l3" href="#release-notes">Release Notes</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Releasing a New NewPipe Version</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#differences-between-regular-and-hotfix-releases">Differences Between Regular and Hotfix Releases</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#regular-releases">Regular Releases</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#feature-branching">Feature Branching</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#merging-featuresbugfixes">Merging Features/Bugfixes</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#creating-a-new-release">Creating a New Release</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#quickfixes">Quickfixes</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#releasing">Releasing</a>
</li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#hotfix-releases">Hotfix Releases</a>
<li class="toctree-l1"> <ul>
<li class="toctree-l3"><a class="reference internal" href="#hotfix-branch">Hotfix Branch</a>
<a class="" href="../06_documentation/">About This Documentation</a>
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="#releasing_1">Releasing</a>
<li class="toctree-l1"> </li>
</ul>
<a class="" href="../07_maintainers_view/">Maintainers' Section</a> </li>
<li class="toctree-l2"><a class="reference internal" href="#version-nomenclature">Version Nomenclature</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#version-nomenclature-of-the-extractor">Version Nomenclature of the Extractor</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-code">Version Code</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#release-notes">Release Notes</a>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -144,6 +149,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -223,6 +229,7 @@ this is what you should do when releasing:</p>
<li>Run <code>fdroid signatures /path/to/newpipe.apk</code>.</li> <li>Run <code>fdroid signatures /path/to/newpipe.apk</code>.</li>
<li>Create a MR.</li> <li>Create a MR.</li>
<li>Rebase quickfix changes back into <strong>dev</strong> if quickfixes were made.</li> <li>Rebase quickfix changes back into <strong>dev</strong> if quickfixes were made.</li>
<li>Temporarily: <a href="https://github.com/TeamNewPipe/website/blob/master/_includes/release_data.html">Update the changelog for the website</a>.</li>
</ol> </ol>
<p><img alt="rebase_back" src="../img/rebase_back_release.svg" /></p> <p><img alt="rebase_back" src="../img/rebase_back_release.svg" /></p>
<h2 id="hotfix-releases">Hotfix Releases</h2> <h2 id="hotfix-releases">Hotfix Releases</h2>
@ -257,6 +264,7 @@ Here's what you do when releasing a hotfix:</p>
<li>Run <code>fdroid signatures /path/to/newpipe.apk</code>.</li> <li>Run <code>fdroid signatures /path/to/newpipe.apk</code>.</li>
<li>Create a MR.</li> <li>Create a MR.</li>
<li>Rebase the hotfix back into <strong>dev</strong> branch.</li> <li>Rebase the hotfix back into <strong>dev</strong> branch.</li>
<li>Temporarily: <a href="https://github.com/TeamNewPipe/website/blob/master/_includes/release_data.html">Update the changelog for the website</a>.</li>
</ol> </ol>
<p><img alt="rebase_back_hotfix" src="../img/rebase_back_hotfix.svg" /></p> <p><img alt="rebase_back_hotfix" src="../img/rebase_back_hotfix.svg" /></p>
<h2 id="version-nomenclature">Version Nomenclature</h2> <h2 id="version-nomenclature">Version Nomenclature</h2>
@ -306,7 +314,7 @@ changes done to the app.</p>
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -316,7 +324,7 @@ changes done to the app.</p>
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -330,6 +338,11 @@ changes done to the app.</p>
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

131
06_documentation/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>About This Documentation - NewPipe Documentation</title> <title>About This Documentation - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,83 +51,62 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1">
<a class="" href="../00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1">
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
<li class="toctree-l1">
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
<li class="toctree-l1">
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
<li class="toctree-l1">
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li>
<li class="toctree-l1">
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">About This Documentation</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#about-this-documentation">About This Documentation</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
<li><a class="toctree-l3" href="#installation">Installation</a></li> </li>
<li><a class="toctree-l3" href="#windows">Windows</a></li>
<li><a class="toctree-l3" href="#macos">MacOS</a></li>
<li><a class="toctree-l3" href="#linuxbsd">Linux/*BSD</a></li>
<li><a class="toctree-l3" href="#androidchromeos">Android/ChromeOS</a></li>
<li><a class="toctree-l3" href="#updating">Updating</a></li>
<li><a class="toctree-l3" href="#using-mkdocs">Using mkdocs</a></li>
<li><a class="toctree-l3" href="#write-and-deploy">Write and Deploy</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">About This Documentation</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#windows">Windows</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#macos">MacOS</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#linuxbsd">Linux/*BSD</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#androidchromeos">Android/ChromeOS</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#updating">Updating</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#using-mkdocs">Using mkdocs</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#write-and-deploy">Write and Deploy</a>
</li>
</ul> </ul>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a>
<a class="" href="../07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -150,6 +131,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -229,7 +211,7 @@ or run <code>sudo pip3 install mkdocs</code> to install mkdocs systemwide. Last
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -239,7 +221,7 @@ or run <code>sudo pip3 install mkdocs</code> to install mkdocs systemwide. Last
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -253,6 +235,11 @@ or run <code>sudo pip3 install mkdocs</code> to install mkdocs systemwide. Last
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

121
07_maintainers_view/index.html
View File

@ -7,6 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico"> <link rel="shortcut icon" href="../img/favicon.ico">
<title>Maintainers' Section - NewPipe Documentation</title> <title>Maintainers' Section - NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a> <a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -49,77 +51,56 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="..">Welcome to NewPipe</a>
</li>
<li class="toctree-l1">
<a class="" href="../00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1">
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
<li class="toctree-l1">
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
<li class="toctree-l1">
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
<li class="toctree-l1">
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li>
<li class="toctree-l1">
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li>
<li class="toctree-l1">
<a class="" href="../06_documentation/">About This Documentation</a>
</li>
<li class="toctree-l1 current">
<a class="current" href="./">Maintainers' Section</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#maintainers-section">Maintainers' Section</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a>
<li><a class="toctree-l3" href="#keep-it-streamlined">Keep it Streamlined</a></li> </li>
<li><a class="toctree-l3" href="#bugfixes">Bugfixes</a></li>
<li><a class="toctree-l3" href="#features">Features</a></li>
<li><a class="toctree-l3" href="#pull-requests">Pull Requests</a></li>
<li><a class="toctree-l3" href="#community">Community</a></li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Maintainers' Section</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#keep-it-streamlined">Keep it Streamlined</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#bugfixes">Bugfixes</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#features">Features</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pull-requests">Pull Requests</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#community">Community</a>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -144,6 +125,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -228,7 +210,7 @@ When you have a bad day, just don't go to GitHub (advice from our experience ;D
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -238,7 +220,7 @@ When you have a bad day, just don't go to GitHub (advice from our experience ;D
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -250,6 +232,11 @@ When you have a bad day, just don't go to GitHub (advice from our experience ;D
<script>var base_url = '..';</script> <script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script> <script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script> <script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

89
404.html
View File

@ -7,17 +7,18 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="/img/favicon.ico"> <link rel="shortcut icon" href="/img/favicon.ico">
<title>NewPipe Documentation</title> <title>NewPipe Documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
<link rel="stylesheet" href="/css/theme.css" type="text/css" /> <link rel="stylesheet" href="/css/theme.css" />
<link rel="stylesheet" href="/css/theme_extra.css" type="text/css" /> <link rel="stylesheet" href="/css/theme_extra.css" />
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" />
<script src="/js/jquery-2.1.1.min.js" defer></script> <script src="/js/jquery-2.1.1.min.js" defer></script>
<script src="/js/modernizr-2.8.3.min.js" defer></script> <script src="/js/modernizr-2.8.3.min.js" defer></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script> <script>hljs.initHighlightingOnLoad();</script>
</head> </head>
@ -28,6 +29,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href="/." class="icon icon-home"> NewPipe Documentation</a> <a href="/." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -38,57 +40,44 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/.">Welcome to NewPipe</a>
<li class="toctree-l1">
<a class="" href="/.">Welcome to NewPipe</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/00_Prepare_everything/">Before You Start</a>
<a class="" href="/00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/01_Concept_of_the_extractor/">Concept of the Extractor</a>
<a class="" href="/01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
<a class="" href="/02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/03_Implement_a_service/">Implementing a Service</a>
<a class="" href="/03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/04_Run_changes_in_App/">Testing Your Changes in the App</a>
<a class="" href="/04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/05_releasing/">Releasing a New NewPipe Version</a>
<a class="" href="/05_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/06_documentation/">About This Documentation</a>
<a class="" href="/06_documentation/">About This Documentation</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="/07_maintainers_view/">Maintainers' Section</a>
<a class="" href="/07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -111,6 +100,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -134,7 +124,7 @@
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -144,7 +134,7 @@
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -154,6 +144,11 @@
<script>var base_url = '/';</script> <script>var base_url = '/';</script>
<script src="/js/theme.js" defer></script> <script src="/js/theme.js" defer></script>
<script src="/search/main.js" defer></script> <script src="/search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

10
css/theme.css
View File

File diff suppressed because one or more lines are too long

93
css/theme_extra.css
View File

@ -1,58 +1,3 @@
/*
* Sphinx doesn't have support for section dividers like we do in
* MkDocs, this styles the section titles in the nav
*
* https://github.com/mkdocs/mkdocs/issues/175
*/
.wy-menu-vertical span {
line-height: 18px;
padding: 0.4045em 1.618em;
display: block;
position: relative;
font-size: 90%;
color: #838383;
}
.wy-menu-vertical .subnav a {
padding: 0.4045em 2.427em;
}
/*
* Long navigations run off the bottom of the screen as the nav
* area doesn't scroll.
*
* https://github.com/mkdocs/mkdocs/pull/202
*
* Builds upon pull 202 https://github.com/mkdocs/mkdocs/pull/202
* to make toc scrollbar end before navigations buttons to not be overlapping.
*/
.wy-nav-side {
height: calc(100% - 45px);
overflow-y: auto;
min-height: 0;
}
.rst-versions{
border-top: 0;
height: 45px;
}
@media screen and (max-width: 768px) {
.wy-nav-side {
height: 100%;
}
}
/*
* readthedocs theme hides nav items when the window height is
* too small to contain them.
*
* https://github.com/mkdocs/mkdocs/issues/#348
*/
.wy-menu-vertical ul {
margin-bottom: 2em;
}
/* /*
* Wrap inline code samples otherwise they shoot of the side and * Wrap inline code samples otherwise they shoot of the side and
* can't be read at all. * can't be read at all.
@ -61,7 +6,7 @@
* https://github.com/mkdocs/mkdocs/issues/233 * https://github.com/mkdocs/mkdocs/issues/233
* https://github.com/mkdocs/mkdocs/issues/834 * https://github.com/mkdocs/mkdocs/issues/834
*/ */
code { .rst-content code {
white-space: pre-wrap; white-space: pre-wrap;
word-wrap: break-word; word-wrap: break-word;
padding: 2px 5px; padding: 2px 5px;
@ -75,7 +20,7 @@ code {
* https://github.com/mkdocs/mkdocs/issues/834 * https://github.com/mkdocs/mkdocs/issues/834
* https://github.com/mkdocs/mkdocs/issues/233 * https://github.com/mkdocs/mkdocs/issues/233
*/ */
pre code { .rst-content pre code {
white-space: pre; white-space: pre;
word-wrap: normal; word-wrap: normal;
display: block; display: block;
@ -83,6 +28,20 @@ pre code {
font-size: 12px; font-size: 12px;
} }
/**
* Fix code colors
*
* https://github.com/mkdocs/mkdocs/issues/2027
*/
.rst-content code {
color: #E74C3C;
}
.rst-content pre code {
color: #000;
background: #f8f8f8;
}
/* /*
* Fix link colors when the link text is inline code. * Fix link colors when the link text is inline code.
* *
@ -117,7 +76,7 @@ pre .cs, pre .c {
* *
* https://github.com/mkdocs/mkdocs/issues/319 * https://github.com/mkdocs/mkdocs/issues/319
*/ */
.no-highlight { .rst-content .no-highlight {
display: block; display: block;
padding: 0.5em; padding: 0.5em;
color: #333; color: #333;
@ -148,27 +107,12 @@ form .search-query {
border-color: #D1D4D5; border-color: #D1D4D5;
} }
.wy-menu-vertical li ul {
display: inherit;
}
.wy-menu-vertical li ul.subnav ul.subnav{
padding-left: 1em;
}
.wy-menu-vertical .subnav li.current > a {
padding-left: 2.42em;
}
.wy-menu-vertical .subnav li.current > ul li a {
padding-left: 3.23em;
}
/* /*
* Improve inline code blocks within admonitions. * Improve inline code blocks within admonitions.
* *
* https://github.com/mkdocs/mkdocs/issues/656 * https://github.com/mkdocs/mkdocs/issues/656
*/ */
.admonition code { .rst-content .admonition code {
color: #404040; color: #404040;
border: 1px solid #c7c9cb; border: 1px solid #c7c9cb;
border: 1px solid rgba(0, 0, 0, 0.2); border: 1px solid rgba(0, 0, 0, 0.2);
@ -194,4 +138,3 @@ td, th {
border: 1px solid #e1e4e5 !important; /* csslint allow: important */ border: 1px solid #e1e4e5 !important; /* csslint allow: important */
border-collapse: collapse; border-collapse: collapse;
} }

BIN
fonts/Lato/lato-bold.eot Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-bold.ttf Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-bold.woff Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-bold.woff2 Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-bolditalic.eot Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-bolditalic.ttf Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-bolditalic.woff Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-bolditalic.woff2 Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-italic.eot Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-italic.ttf Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-italic.woff Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-italic.woff2 Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-regular.eot Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-regular.ttf Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-regular.woff Normal file
View File

Binary file not shown.

BIN
fonts/Lato/lato-regular.woff2 Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-bold.eot Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-bold.ttf Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-bold.woff Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-bold.woff2 Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-regular.eot Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-regular.ttf Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-regular.woff Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab-v7-regular.woff2 Normal file
View File

Binary file not shown.

BIN
fonts/RobotoSlab/roboto-slab.eot Normal file
View File

Binary file not shown.

BIN
fonts/fontawesome-webfont.eot
View File

Binary file not shown.

3060
fonts/fontawesome-webfont.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 193 KiB

After

Width:  |  Height:  |  Size: 434 KiB

BIN
fonts/fontawesome-webfont.ttf
View File

Binary file not shown.

BIN
fonts/fontawesome-webfont.woff
View File

Binary file not shown.

BIN
fonts/fontawesome-webfont.woff2 Normal file
View File

Binary file not shown.

99
index.html
View File

@ -7,8 +7,9 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="None"> <meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico"> <link rel="shortcut icon" href="img/favicon.ico">
<title>Welcome to NewPipe - NewPipe Documentation</title> <title>NewPipe Documentation</title>
<!-- local fonts --> <!-- local fonts -->
<link rel="stylesheet" href="./css/local_fonts.css" type="text/css" /> <link rel="stylesheet" href="./css/local_fonts.css" type="text/css" />
@ -39,6 +40,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href="." class="icon icon-home"> NewPipe Documentation</a> <a href="." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -50,68 +52,47 @@
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href=".">Welcome to NewPipe</a>
<ul class="current">
<li class="toctree-l1 current"> <li class="toctree-l2"><a class="reference internal" href="#introduction">Introduction</a>
</li>
<a class="current" href=".">Welcome to NewPipe</a> </ul>
<ul class="subnav"> </li>
</ul>
<li class="toctree-l2"><a href="#welcome-to-newpipe">Welcome to NewPipe</a></li>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="00_Prepare_everything/">Before You Start</a>
<li><a class="toctree-l3" href="#introduction">Introduction</a></li> </li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="03_Implement_a_service/">Implementing a Service</a>
<a class="" href="00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="04_Run_changes_in_App/">Testing Your Changes in the App</a>
<a class="" href="01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="05_releasing/">Releasing a New NewPipe Version</a>
<a class="" href="02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="06_documentation/">About This Documentation</a>
<a class="" href="03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="07_maintainers_view/">Maintainers' Section</a>
<a class="" href="04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
<li class="toctree-l1">
<a class="" href="05_releasing/">Releasing a New NewPipe Version</a>
</li>
<li class="toctree-l1">
<a class="" href="06_documentation/">About This Documentation</a>
</li>
<li class="toctree-l1">
<a class="" href="07_maintainers_view/">Maintainers' Section</a>
</li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -136,6 +117,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -170,7 +152,7 @@ It focuses on making it possible for the creator of a scraper for a streaming se
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -180,7 +162,7 @@ It focuses on making it possible for the creator of a scraper for a streaming se
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -192,11 +174,16 @@ It focuses on making it possible for the creator of a scraper for a streaming se
<script>var base_url = '.';</script> <script>var base_url = '.';</script>
<script src="js/theme.js" defer></script> <script src="js/theme.js" defer></script>
<script src="search/main.js" defer></script> <script src="search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>
<!-- <!--
MkDocs version : 1.0.4 MkDocs version : 1.1.2
Build Date UTC : 2020-05-21 17:17:59 Build Date UTC : 2020-08-13 00:02:52.633498+00:00
--> -->

108
js/theme.js
View File

@ -1,105 +1,3 @@
$( document ).ready(function() { /* sphinx_rtd_theme version 0.4.1 | MIT license */
// Shift nav in mobile when clicking the menu. /* Built 20180727 10:07 */
$(document).on('click', "[data-toggle='wy-nav-top']", function() { require=function n(e,i,t){function o(s,a){if(!i[s]){if(!e[s]){var l="function"==typeof require&&require;if(!a&&l)return l(s,!0);if(r)return r(s,!0);var c=new Error("Cannot find module '"+s+"'");throw c.code="MODULE_NOT_FOUND",c}var u=i[s]={exports:{}};e[s][0].call(u.exports,function(n){var i=e[s][1][n];return o(i||n)},u,u.exports,n,e,i,t)}return i[s].exports}for(var r="function"==typeof require&&require,s=0;s<t.length;s++)o(t[s]);return o}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var e=this;void 0===n&&(n=!0),e.isRunning||(e.isRunning=!0,jQuery(function(i){e.init(i),e.reset(),e.win.on("hashchange",e.reset),n&&e.win.on("scroll",function(){e.linkScroll||e.winScroll||(e.winScroll=!0,requestAnimationFrame(function(){e.onScroll()}))}),e.win.on("resize",function(){e.winResize||(e.winResize=!0,requestAnimationFrame(function(){e.onResize()}))}),e.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var i=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(i),e.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")}),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var i=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",function(n){return e.toggleCurrent(i),n.stopPropagation(),!1}),i.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}i.length>0&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"))}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],i=0;i<e.length&&!window.requestAnimationFrame;++i)window.requestAnimationFrame=window[e[i]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[i]+"CancelAnimationFrame"]||window[e[i]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,i){var t=(new Date).getTime(),o=Math.max(0,16-(t-n)),r=window.setTimeout(function(){e(t+o)},o);return n=t+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);
$("[data-toggle='wy-nav-shift']").toggleClass("shift");
$("[data-toggle='rst-versions']").toggleClass("shift");
});
// Close menu when you click a link.
$(document).on('click', ".wy-menu-vertical .current ul li a", function() {
$("[data-toggle='wy-nav-shift']").removeClass("shift");
$("[data-toggle='rst-versions']").toggleClass("shift");
});
// Keyboard navigation
document.addEventListener("keydown", function(e) {
var key = e.which || e.keyCode || window.event && window.event.keyCode;
var page;
switch (key) {
case 78: // n
page = $('[role="navigation"] a:contains(Next):first').prop('href');
break;
case 80: // p
page = $('[role="navigation"] a:contains(Previous):first').prop('href');
break;
case 13: // enter
if (e.target === document.getElementById('mkdocs-search-query')) {
e.preventDefault();
}
break;
default: break;
}
if ($(e.target).is(':input')) {
return true;
} else if (page) {
window.location.href = page;
}
});
$(document).on('click', "[data-toggle='rst-current-version']", function() {
$("[data-toggle='rst-versions']").toggleClass("shift-up");
});
// Make tables responsive
$("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");
$('table').addClass('docutils');
});
window.SphinxRtdTheme = (function (jquery) {
var stickyNav = (function () {
var navBar,
win,
stickyNavCssClass = 'stickynav',
applyStickNav = function () {
if (navBar.height() <= win.height()) {
navBar.addClass(stickyNavCssClass);
} else {
navBar.removeClass(stickyNavCssClass);
}
},
enable = function () {
applyStickNav();
win.on('resize', applyStickNav);
},
init = function () {
navBar = jquery('nav.wy-nav-side:first');
win = jquery(window);
};
jquery(init);
return {
enable : enable
};
}());
return {
StickyNav : stickyNav
};
}($));
// The code below is a copy of @seanmadsen code posted Jan 10, 2017 on issue 803.
// https://github.com/mkdocs/mkdocs/issues/803
// This just incorporates the auto scroll into the theme itself without
// the need for additional custom.js file.
//
$(function() {
$.fn.isFullyWithinViewport = function(){
var viewport = {};
viewport.top = $(window).scrollTop();
viewport.bottom = viewport.top + $(window).height();
var bounds = {};
bounds.top = this.offset().top;
bounds.bottom = bounds.top + this.outerHeight();
return ( ! (
(bounds.top <= viewport.top) ||
(bounds.bottom >= viewport.bottom)
) );
};
if( $('li.toctree-l1.current').length && !$('li.toctree-l1.current').isFullyWithinViewport() ) {
$('.wy-nav-side')
.scrollTop(
$('li.toctree-l1.current').offset().top -
$('.wy-nav-side').offset().top -
60
);
}
});

89
search.html
View File

@ -7,17 +7,22 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="./img/favicon.ico"> <link rel="shortcut icon" href="./img/favicon.ico">
<title>NewPipe Documentation</title> <title>NewPipe Documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> <!-- local fonts -->
<link rel="stylesheet" href="./css/local_fonts.css" type="text/css" />
<link rel="stylesheet" href="./css/theme.css" type="text/css" /> <link rel="stylesheet" href="./css/theme.css" type="text/css" />
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" /> <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css"> <link rel="stylesheet" href="./css/theme_child.css" type="text/css" />
<!-- local code syntax highlighting -->
<link rel="stylesheet" href="./css/github.min.css" type="text/css" />
<link rel="stylesheet" href="./css/highlight.css" type="text/css" />
<script src="./js/jquery-2.1.1.min.js" defer></script> <script src="./js/jquery-2.1.1.min.js" defer></script>
<script src="./js/modernizr-2.8.3.min.js" defer></script> <script src="./js/modernizr-2.8.3.min.js" defer></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script> <script src="./js/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script> <script>hljs.initHighlightingOnLoad();</script>
</head> </head>
@ -28,6 +33,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search"> <div class="wy-side-nav-search">
<a href="./." class="icon icon-home"> NewPipe Documentation</a> <a href="./." class="icon icon-home"> NewPipe Documentation</a>
<div role="search"> <div role="search">
@ -38,57 +44,44 @@
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./.">Welcome to NewPipe</a>
<li class="toctree-l1">
<a class="" href="./.">Welcome to NewPipe</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./00_Prepare_everything/">Before You Start</a>
<a class="" href="./00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./01_Concept_of_the_extractor/">Concept of the Extractor</a>
<a class="" href="./01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
<a class="" href="./02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./03_Implement_a_service/">Implementing a Service</a>
<a class="" href="./03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./04_Run_changes_in_App/">Testing Your Changes in the App</a>
<a class="" href="./04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./05_releasing/">Releasing a New NewPipe Version</a>
<a class="" href="./05_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./06_documentation/">About This Documentation</a>
<a class="" href="./06_documentation/">About This Documentation</a>
</li> </li>
</ul>
<li class="toctree-l1"> <ul>
<li class="toctree-l1"><a class="reference internal" href="./07_maintainers_view/">Maintainers' Section</a>
<a class="" href="./07_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
&nbsp; </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
@ -111,6 +104,7 @@
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main"> <div role="main">
@ -141,7 +135,7 @@
</div> </div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
@ -151,7 +145,7 @@
</div> </div>
<div class="rst-versions" role="note" style="cursor: pointer"> <div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
@ -161,6 +155,11 @@
<script>var base_url = '.';</script> <script>var base_url = '.';</script>
<script src="./js/theme.js" defer></script> <script src="./js/theme.js" defer></script>
<script src="./search/main.js" defer></script> <script src="./search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body> </body>
</html> </html>

771
search/lunr.js
View File

File diff suppressed because it is too large Load Diff

4
search/main.js
View File

@ -43,7 +43,7 @@ function displayResults (results) {
function doSearch () { function doSearch () {
var query = document.getElementById('mkdocs-search-query').value; var query = document.getElementById('mkdocs-search-query').value;
if (query.length > 2) { if (query.length > min_search_length) {
if (!window.Worker) { if (!window.Worker) {
displayResults(search(query)); displayResults(search(query));
} else { } else {
@ -73,6 +73,8 @@ function onWorkerMessage (e) {
} else if (e.data.results) { } else if (e.data.results) {
var results = e.data.results; var results = e.data.results;
displayResults(results); displayResults(results);
} else if (e.data.config) {
min_search_length = e.data.config.min_search_length-1;
} }
} }

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

2
search/worker.js
View File

@ -58,6 +58,7 @@ function onScriptsLoaded () {
if (data.config && data.config.separator && data.config.separator.length) { if (data.config && data.config.separator && data.config.separator.length) {
lunr.tokenizer.separator = new RegExp(data.config.separator); lunr.tokenizer.separator = new RegExp(data.config.separator);
} }
if (data.index) { if (data.index) {
index = lunr.Index.load(data.index); index = lunr.Index.load(data.index);
data.docs.forEach(function (doc) { data.docs.forEach(function (doc) {
@ -84,6 +85,7 @@ function onScriptsLoaded () {
console.log('Lunr index built, search ready'); console.log('Lunr index built, search ready');
} }
allowSearch = true; allowSearch = true;
postMessage({config: data.config});
postMessage({allowSearch: allowSearch}); postMessage({allowSearch: allowSearch});
} }

45
sitemap.xml
View File

@ -1,48 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<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>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url><url>
<url>
<loc>None</loc> <loc>None</loc>
<lastmod>2020-05-21</lastmod> <lastmod>2020-08-13</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
</urlset> </urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.