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

Deployed b7c7088 with MkDocs version: 1.2.3

This commit is contained in:
TobiGr 2022-02-11 22:16:29 +01:00
parent 3c1f47884b
commit ec1370a1fb
15 changed files with 395 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
00_Prepare_everything/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
@ -89,15 +89,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -109,7 +113,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>
@ -155,7 +159,7 @@ and are open for everyone to help :)</p>
<ul> <ul>
<li>A dev environment/IDE that supports:<ul> <li>A dev environment/IDE that supports:<ul>
<li><strong><a href="https://git-scm.com/downloads/guis">Git</a></strong></li> <li><strong><a href="https://git-scm.com/downloads/guis">Git</a></strong></li>
<li><strong><a href="https://www.java.com/en/download/faq/java8.xml">Java 8</a></strong></li> <li><strong><a href="https://adoptium.net/?variant=openjdk8&amp;jvmVariant=hotspot">Java 8</a></strong></li>
<li><strong><a href="https://gradle.org/">Gradle</a></strong></li> <li><strong><a href="https://gradle.org/">Gradle</a></strong></li>
<li><strong><a href="https://junit.org/junit5/">Unit testing</a></strong></li> <li><strong><a href="https://junit.org/junit5/">Unit testing</a></strong></li>
<li><a href="https://www.jetbrains.com/idea/">IDEA Community</a> (Strongly recommended, but not required)</li> <li><a href="https://www.jetbrains.com/idea/">IDEA Community</a> (Strongly recommended, but not required)</li>
@ -216,7 +220,7 @@ As Gradle Project, select NewPipeExtractor. As a task, add "test". Now save and
<a href="../01_Concept_of_the_extractor/" class="btn btn-neutral float-right" title="Concept of the Extractor">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../01_Concept_of_the_extractor/" class="btn btn-neutral float-right" title="Concept of the Extractor">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href=".." class="btn btn-neutral" title="Welcome to NewPipe"><span class="icon icon-circle-arrow-left"></span> Previous</a> <a href=".." class="btn btn-neutral" title="Welcome to the NewPipe Development Docs"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>

18
01_Concept_of_the_extractor/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -89,15 +89,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -109,7 +113,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>

18
02_Concept_of_LinkHandler/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -89,15 +89,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -109,7 +113,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>

20
03_Implement_a_service/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -97,15 +97,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -117,7 +121,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>
@ -172,7 +176,7 @@ ask us to introduce a new library than start using Regex too often.</p>
<ul> <ul>
<li>Html/XML Parsing: <a href="https://jsoup.org/apidocs/overview-summary.html">jsoup</a></li> <li>Html/XML Parsing: <a href="https://jsoup.org/apidocs/overview-summary.html">jsoup</a></li>
<li>JSON Parsing: <a href="https://github.com/mmastrac/nanojson#parser-example">nanojson</a></li> <li>JSON Parsing: <a href="https://github.com/mmastrac/nanojson#parser-example">nanojson</a></li>
<li>JavaScript Parsing/Execution: <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/Documentation">Mozilla Rhino</a></li> <li>JavaScript Parsing/Execution: <a href="https://github.com/mozilla/rhino">Mozilla Rhino</a></li>
<li>Link detection in strings: <a href="https://github.com/robinst/autolink-java">AutoLink</a></li> <li>Link detection in strings: <a href="https://github.com/robinst/autolink-java">AutoLink</a></li>
</ul> </ul>
<p>If you need to introduce new libraries, please tell us before you do so.</p> <p>If you need to introduce new libraries, please tell us before you do so.</p>

24
04_Run_changes_in_App/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -91,15 +91,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -111,7 +115,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>
@ -138,7 +142,7 @@
<h1 id="testing-your-changes-in-the-app">Testing Your Changes in the App</h1> <h1 id="testing-your-changes-in-the-app">Testing Your 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 with provided by the NewPipe Extractor and IDEA. If you want to try it with
the actual fronted, you need to follow these steps.</p> the actual frontend, 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, you'll want to set up a working Android Studio environment. To do this, <p>First, you'll want to set up a working Android Studio environment. To do this,
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>,
@ -192,7 +196,7 @@ click on that little paper symbol next to the <code>GET IT</code> button. If it'
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../05_releasing/" class="btn btn-neutral float-right" title="Releasing a New NewPipe Version">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../05_Mock_tests/" class="btn btn-neutral float-right" title="Mock Tests">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../03_Implement_a_service/" class="btn btn-neutral" title="Implementing a Service"><span class="icon icon-circle-arrow-left"></span> Previous</a> <a href="../03_Implement_a_service/" class="btn btn-neutral" title="Implementing a Service"><span class="icon icon-circle-arrow-left"></span> Previous</a>
@ -224,7 +228,7 @@ click on that little paper symbol next to the <code>GET IT</code> button. If it'
<span><a href="../03_Implement_a_service/" style="color: #fcfcfc">&laquo; Previous</a></span> <span><a href="../03_Implement_a_service/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../05_releasing/" style="color: #fcfcfc">Next &raquo;</a></span> <span><a href="../05_Mock_tests/" style="color: #fcfcfc">Next &raquo;</a></span>
</span> </span>
</div> </div>

234
05_Mock_tests/index.html Normal file
View File

@ -0,0 +1,234 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Mock Tests - NewPipe Development Documentation</title>
<!-- 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_extra.css" type="text/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>
// Current page data
var mkdocs_page_name = "Mock Tests";
var mkdocs_page_input_path = "05_Mock_tests.md";
var mkdocs_page_url = null;
</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/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<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 the NewPipe Development Docs</a>
</li>
</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="./">Mock Tests</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#multiple-downloader-implementations">Multiple downloader implementations</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mock-only-tests">Mock only tests</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Mock Tests</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="mock-tests">Mock Tests</h1>
<p>A web crawler is, by its very nature, dependent on the external service which it is crawling.
In order to have a reliable CI pipeline, this external dependency needs to be removed.
For this, there is a system in place to automatically save the requests made to a service, as well as the responses received.
These can then be used in the CI pipeline to reliably test changes made to the Extractor, and avoid test failures due to API changes on the side of the service.</p>
<h2 id="multiple-downloader-implementations">Multiple downloader implementations</h2>
<p>There are multiple implementations of the abstract class <code>Downloader</code></p>
<ol>
<li><code>DownloaderTestImpl</code> is used for running the test against the actual service.</li>
<li><code>RecordingDownloader</code> is used to save the request and response to a file, thus creating the mock.</li>
<li><code>MockDownloader</code> is used to answer requests using the saved mocks.</li>
</ol>
<h3 id="usage">Usage</h3>
<p>There are 2 ways to specify which downloader should be used.</p>
<p>First one is passing the <code>-Ddownloader=&lt;value&gt;</code> argument from the command line, where <code>value</code> can be one of
<a href="https://github.com/TeamNewPipe/NewPipeExtractor/blob/dev/extractor/src/test/java/org/schabi/newpipe/downloader/DownloaderType.java">DownloaderType</a>
. The main use case is in the CI pipeline, like this: <code>./gradlew check --stacktrace -Ddownloader=MOCK</code>.<br />
Other than that it can also be used to mass generate mocks by specifying which package should be tested. For example, if
one wanted to update all YouTube mocks:
<code>gradle clean test --tests 'org.schabi.newpipe.extractor.services.youtube.*' -Ddownloader=RECORDING</code></p>
<p>The second way is changing the field <code>DownloaderFactory.DEFAULT_DOWNLOADER</code>.
The default value is <code>DownloaderType.REAL</code> which should not be changed on the master branch.
Locally one can change this to <code>DownloaderType.RECORDING</code>, run the tests and commit
the generated mocks.<br />
This is the main use case for when developing locally.</p>
<h3 id="mock-only-tests">Mock only tests</h3>
<p>There are some things which cannot ever be tested reliably against an actual service.
For example, tests for an upcoming livestream would fail after the livestream starts.</p>
<p>For this, there is a marker interface <code>MockOnly</code>, and a custom TestRule <code>MockOnlyRule</code>.
It skips the tests in the CI pipeline if they are not run with mocks.</p>
<p>See <code>MockOnlyRule</code> for further details.</p>
<p>Example usage:</p>
<pre><code class="language-java">public static class TestClass {
@Rule
public MockOnlyRule rule = new MockOnlyRule();
@MockOnly
@Test
public void myTest() throws Exception {
//assertions
}
}
</code></pre>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../06_releasing/" class="btn btn-neutral float-right" title="Releasing a New NewPipe Version">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../04_Run_changes_in_App/" class="btn btn-neutral" title="Testing Your Changes in the App"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
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>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../04_Run_changes_in_App/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../06_releasing/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

36
05_releasing/index.html → 06_releasing/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -23,7 +23,7 @@
<script> <script>
// Current page data // Current page data
var mkdocs_page_name = "Releasing a New NewPipe Version"; var mkdocs_page_name = "Releasing a New NewPipe Version";
var mkdocs_page_input_path = "05_releasing.md"; var mkdocs_page_input_path = "06_releasing.md";
var mkdocs_page_url = null; var mkdocs_page_url = null;
</script> </script>
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -74,6 +74,10 @@
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a> <li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li> </li>
</ul> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li>
</ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Releasing a New NewPipe Version</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Releasing a New NewPipe Version</a>
<ul class="current"> <ul class="current">
@ -121,11 +125,11 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -137,7 +141,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>
@ -218,9 +222,9 @@ Be aware of the rule that a release should never be done on a Friday.
For NewPipe, this means: <strong>Don't do a release if you don't have time for it!!!</strong></p> For NewPipe, this means: <strong>Don't do a release if you don't have time for it!!!</strong></p>
<p>By following the steps listed below, you can publish a stable version of NewPipe:</p> <p>By following the steps listed below, you can publish a stable version of NewPipe:</p>
<ol> <ol>
<li><a href="../07_maintainers_view#merge-changes-from-weblate-into-newpipe">Merge the translations from Weblate into NewPipe</a>.</li> <li><a href="../08_maintainers_view#merge-changes-from-weblate-into-newpipe">Merge the translations from Weblate into NewPipe</a>.</li>
<li>Update your local <strong>dev</strong> branch and create a <a href="#changelog-file">changelog file</a>. <li>Update your local <strong>dev</strong> branch and create a <a href="#changelog-file">changelog file</a>.
Make sure to push the changes and <a href="../07_maintainers_view#update-weblate">update Weblate</a>.</li> Make sure to push the changes and <a href="../08_maintainers_view#update-weblate">update Weblate</a>.</li>
<li>In your local NewPipe repo, fork the <strong>dev</strong> branch into a new <strong>release/x.y.z</strong> branch. </li> <li>In your local NewPipe repo, fork the <strong>dev</strong> branch into a new <strong>release/x.y.z</strong> branch. </li>
<li>Increase the <a href="#version-nomenclature">version number</a> and update the version code in the <code>build.gradle</code> file.</li> <li>Increase the <a href="#version-nomenclature">version number</a> and update the version code in the <code>build.gradle</code> file.</li>
<li>Open a pull request form the new <strong>release/x.y.z</strong> branch into the <strong>master</strong> branch.</li> <li>Open a pull request form the new <strong>release/x.y.z</strong> branch into the <strong>master</strong> branch.</li>
@ -239,7 +243,7 @@ For NewPipe, this means: <strong>Don't do a release if you don't have time for i
PRs which aim to fix regressions of the upcoming release need to target the <strong>release/x.y.z</strong> branch. PRs which aim to fix regressions of the upcoming release need to target the <strong>release/x.y.z</strong> branch.
Read <a href="#quickfixes">Quickfixes</a> for more info.</p> Read <a href="#quickfixes">Quickfixes</a> for more info.</p>
<p>The changelogs are translated during the test phase. <p>The changelogs are translated during the test phase.
Therefore, <a href="../07_maintainers_view#merge-changes-from-weblate-into-newpipe">the translations need to be merged from Weblate</a> once more. Therefore, <a href="../08_maintainers_view#merge-changes-from-weblate-into-newpipe">the translations need to be merged from Weblate</a> once more.
The translation commit is cherry-picked into the release branch.</p> The translation commit is cherry-picked into the release branch.</p>
<p>Once testing is done and the release branch does not contain critical regressions, and you think the update is ready, <p>Once testing is done and the release branch does not contain critical regressions, and you think the update is ready,
proceed with <a href="#releasing">releasing the new version</a>.</p> proceed with <a href="#releasing">releasing the new version</a>.</p>
@ -258,7 +262,7 @@ Increment the version number in the filename of the release candidate. e.g. <cod
<p><img alt="release_branch" src="../img/release_branch.svg" /></p> <p><img alt="release_branch" src="../img/release_branch.svg" /></p>
<h3 id="releasing">Releasing</h3> <h3 id="releasing">Releasing</h3>
<p>Once the glorious day of all days has come, and you fulfill the ceremony of releasing. <p>Once the glorious day of all days has come, and you fulfill the ceremony of releasing.
After going through the release procedure of <a href="#create_a_new_release">creating a new release</a> After going through the release procedure of <a href="#creating-a-new-release">creating a new release</a>
and maybe a few <a href="#quickfixes">quickfixes</a> on the new release, and maybe a few <a href="#quickfixes">quickfixes</a> on the new release,
this is what you should do when releasing:</p> this is what you should do when releasing:</p>
<ol> <ol>
@ -388,7 +392,7 @@ This causes troubles for translators, because Weblate enforces the 500 bytes lim
For this reason it is recommended to keep the changelog at 400 bytes.</p> For this reason it is recommended to keep the changelog at 400 bytes.</p>
<p>When creating the changelog file be aware of changes which were done in the extractor as well.<br /> <p>When creating the changelog file be aware of changes which were done in the extractor as well.<br />
Before pushing the changelog to NewPipe's repo, ask other maintainers to review it.<br /> Before pushing the changelog to NewPipe's repo, ask other maintainers to review it.<br />
After pushing the changelog to NewPipe's GitHub repo, <a href="07_maintainers_view/#update-webalte">updating Weblate</a> is necessary. After pushing the changelog to NewPipe's GitHub repo, <a href="../08_maintainers_view#update-weblate">updating Weblate</a> is necessary.
This enables translators to work on localized versions of the changelog before a release is tagged and published.</p> This enables translators to work on localized versions of the changelog before a release is tagged and published.</p>
<h2 id="publish-on-f-droid">Publish on F-Droid</h2> <h2 id="publish-on-f-droid">Publish on F-Droid</h2>
<p>NewPipe is and supports open source software. <p>NewPipe is and supports open source software.
@ -428,10 +432,10 @@ An example commit containing all required changes can be found <a href="https://
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../06_documentation/" class="btn btn-neutral float-right" title="About This Documentation">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../07_documentation/" class="btn btn-neutral float-right" title="About This Documentation">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../04_Run_changes_in_App/" class="btn btn-neutral" title="Testing Your Changes in the App"><span class="icon icon-circle-arrow-left"></span> Previous</a> <a href="../05_Mock_tests/" class="btn btn-neutral" title="Mock Tests"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
@ -457,10 +461,10 @@ An example commit containing all required changes can be found <a href="https://
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../04_Run_changes_in_App/" style="color: #fcfcfc">&laquo; Previous</a></span> <span><a href="../05_Mock_tests/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../06_documentation/" style="color: #fcfcfc">Next &raquo;</a></span> <span><a href="../07_documentation/" style="color: #fcfcfc">Next &raquo;</a></span>
</span> </span>
</div> </div>

26
06_documentation/index.html → 07_documentation/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -23,7 +23,7 @@
<script> <script>
// Current page data // Current page data
var mkdocs_page_name = "About This Documentation"; var mkdocs_page_name = "About This Documentation";
var mkdocs_page_input_path = "06_documentation.md"; var mkdocs_page_input_path = "07_documentation.md";
var mkdocs_page_url = null; var mkdocs_page_url = null;
</script> </script>
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -75,7 +75,11 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
@ -101,7 +105,7 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -113,7 +117,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>
@ -196,10 +200,10 @@ or run <code>sudo pip3 install mkdocs</code> to install mkdocs systemwide. Last
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../07_maintainers_view/" class="btn btn-neutral float-right" title="Maintainers' Section">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../08_maintainers_view/" class="btn btn-neutral float-right" title="Maintainers' Section">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../05_releasing/" class="btn btn-neutral" title="Releasing a New NewPipe Version"><span class="icon icon-circle-arrow-left"></span> Previous</a> <a href="../06_releasing/" class="btn btn-neutral" title="Releasing a New NewPipe Version"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
@ -225,10 +229,10 @@ or run <code>sudo pip3 install mkdocs</code> to install mkdocs systemwide. Last
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../05_releasing/" style="color: #fcfcfc">&laquo; Previous</a></span> <span><a href="../06_releasing/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../07_maintainers_view/" style="color: #fcfcfc">Next &raquo;</a></span> <span><a href="../08_maintainers_view/" style="color: #fcfcfc">Next &raquo;</a></span>
</span> </span>
</div> </div>

22
07_maintainers_view/index.html → 08_maintainers_view/index.html
View File

@ -9,7 +9,7 @@
<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 Development 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" />
@ -23,7 +23,7 @@
<script> <script>
// Current page data // Current page data
var mkdocs_page_name = "Maintainers' Section"; var mkdocs_page_name = "Maintainers' Section";
var mkdocs_page_input_path = "07_maintainers_view.md"; var mkdocs_page_input_path = "08_maintainers_view.md";
var mkdocs_page_url = null; var mkdocs_page_url = null;
</script> </script>
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -75,11 +75,15 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../07_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
@ -115,7 +119,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a> <a href="..">NewPipe Development Documentation</a>
</nav> </nav>
@ -243,7 +247,7 @@ If there are conflicts when rebasing weblate, resolve them.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../06_documentation/" class="btn btn-neutral" title="About This Documentation"><span class="icon icon-circle-arrow-left"></span> Previous</a> <a href="../07_documentation/" class="btn btn-neutral" title="About This Documentation"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
@ -269,7 +273,7 @@ If there are conflicts when rebasing weblate, resolve them.</p>
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../06_documentation/" style="color: #fcfcfc">&laquo; Previous</a></span> <span><a href="../07_documentation/" style="color: #fcfcfc">&laquo; Previous</a></span>
</span> </span>

18
404.html
View File

@ -9,7 +9,7 @@
<link rel="shortcut icon" href="/img/favicon.ico"> <link rel="shortcut icon" href="/img/favicon.ico">
<title>NewPipe Documentation</title> <title>NewPipe Development Documentation</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" /> <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" /> <link rel="stylesheet" href="/css/theme.css" />
@ -30,7 +30,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -40,7 +40,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="/.">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="/.">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -64,15 +64,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="/05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="/06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="/07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -84,7 +88,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/.">NewPipe Documentation</a> <a href="/.">NewPipe Development Documentation</a>
</nav> </nav>

26
index.html
View File

@ -9,7 +9,7 @@
<link rel="shortcut icon" href="img/favicon.ico"> <link rel="shortcut icon" href="img/favicon.ico">
<title>NewPipe Documentation</title> <title>NewPipe Development 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" />
@ -22,7 +22,7 @@
<script> <script>
// Current page data // Current page data
var mkdocs_page_name = "Welcome to NewPipe"; var mkdocs_page_name = "Welcome to the NewPipe Development Docs";
var mkdocs_page_input_path = "index.md"; var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = null; var mkdocs_page_url = null;
</script> </script>
@ -41,7 +41,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -51,7 +51,7 @@
<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> <li class="toctree-l1 current"><a class="reference internal current" href=".">Welcome to the NewPipe Development Docs</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#introduction">Introduction</a> <li class="toctree-l2"><a class="reference internal" href="#introduction">Introduction</a>
</li> </li>
@ -79,15 +79,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -99,7 +103,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">NewPipe Documentation</a> <a href=".">NewPipe Development Documentation</a>
</nav> </nav>
@ -111,7 +115,7 @@
<li>Welcome to NewPipe</li> <li>Welcome to the NewPipe Development Docs</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
@ -123,7 +127,7 @@
<div role="main"> <div role="main">
<div class="section"> <div class="section">
<h1 id="welcome-to-newpipe">Welcome to NewPipe</h1> <h1 id="welcome-to-the-newpipe-development-docs">Welcome to the NewPipe Development Docs</h1>
<p><img width=150 src="https://raw.githubusercontent.com/TeamNewPipe/NewPipe/dev/assets/new_pipe_icon_5.png"/></p> <p><img width=150 src="https://raw.githubusercontent.com/TeamNewPipe/NewPipe/dev/assets/new_pipe_icon_5.png"/></p>
<p>This site is/should be a beginner friendly tutorial and documentation for people who want to use or write services for the <a href="https://github.com/TeamNewPipe/NewPipeExtractor">NewPipe Extractor</a>. However, it also contains several notes about how to maintain NewPipe. <p>This site is/should be a beginner friendly tutorial and documentation for people who want to use or write services for the <a href="https://github.com/TeamNewPipe/NewPipeExtractor">NewPipe Extractor</a>. However, it also contains several notes about how to maintain NewPipe.
It is an addition to our auto generated <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/">Jdoc documentation</a>.</p> It is an addition to our auto generated <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/">Jdoc documentation</a>.</p>
@ -186,5 +190,5 @@ It focuses on making it possible for the creator of a scraper for a streaming se
<!-- <!--
MkDocs version : 1.2.3 MkDocs version : 1.2.3
Build Date UTC : 2021-10-20 23:09:50.015755+00:00 Build Date UTC : 2022-02-11 21:16:29.427664+00:00
--> -->

18
search.html
View File

@ -9,7 +9,7 @@
<link rel="shortcut icon" href="./img/favicon.ico"> <link rel="shortcut icon" href="./img/favicon.ico">
<title>NewPipe Documentation</title> <title>NewPipe Development 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" />
@ -34,7 +34,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-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 Development Documentation</a>
<div role="search"> <div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get"> <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" /> <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
@ -44,7 +44,7 @@
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="./.">Welcome to NewPipe</a> <li class="toctree-l1"><a class="reference internal" href="./.">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
@ -68,15 +68,19 @@
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./05_releasing/">Releasing a New NewPipe Version</a> <li class="toctree-l1"><a class="reference internal" href="./05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./06_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="./06_releasing/">Releasing a New NewPipe Version</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./07_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="./07_documentation/">About This Documentation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="./08_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -88,7 +92,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="./.">NewPipe Documentation</a> <a href="./.">NewPipe Development Documentation</a>
</nav> </nav>

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

23
sitemap.xml
View File

@ -2,47 +2,52 @@
<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>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2021-10-20</lastmod> <lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-02-11</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
</urlset> </urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.