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

Deployed 3929a28 with MkDocs version: 1.2.3

This commit is contained in:
TobiGr 2022-08-28 13:42:37 +02:00
parent a6c51aae78
commit 9a3ee8802b
54 changed files with 1263 additions and 949 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
00_Prepare_everything/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Before You Start - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -32,24 +36,26 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</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">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Before You Start</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Before You Start</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#setting-up-your-dev-environment">Setting Up Your Dev Environment</a> <li class="toctree-l2"><a class="reference internal" href="#setting-up-your-dev-environment">Setting Up Your Dev Environment</a>
<ul> <ul>
@ -64,66 +70,76 @@
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Before You Start</li>
<li>Before You Start</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="before-you-start">Before You Start</h1> <h1 id="before-you-start">Before You Start</h1>
<p>These documents will guide you through the process of understanding or creating your own Extractor <p>These documents will guide you through the process of understanding or creating your own Extractor
@ -200,21 +216,29 @@ As Gradle Project, select NewPipeExtractor. As a task, add "test". Now save and
</ul> </ul>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href=".." class="btn btn-neutral float-left" title="Welcome to the NewPipe Development Docs"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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 the NewPipe Development Docs"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -222,7 +246,7 @@ As Gradle Project, select NewPipeExtractor. As a task, add "test". Now save and
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

160
01_Concept_of_the_extractor/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Concept of the Extractor - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -32,28 +36,30 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Concept of the Extractor</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Concept of the Extractor</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#the-collectorextractor-pattern">The Collector/Extractor Pattern</a> <li class="toctree-l2"><a class="reference internal" href="#the-collectorextractor-pattern">The Collector/Extractor Pattern</a>
<ul> <ul>
@ -68,62 +74,72 @@
<li class="toctree-l2"><a class="reference internal" href="#listextractor">ListExtractor</a> <li class="toctree-l2"><a class="reference internal" href="#listextractor">ListExtractor</a>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Concept of the Extractor</li>
<li>Concept of the Extractor</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="concept-of-the-extractor">Concept of the Extractor</h1> <h1 id="concept-of-the-extractor">Concept of the Extractor</h1>
<h2 id="the-collectorextractor-pattern">The Collector/Extractor Pattern</h2> <h2 id="the-collectorextractor-pattern">The Collector/Extractor Pattern</h2>
@ -271,21 +287,29 @@ items like a regular web page, but all the others as an AJAX request.</p>
</code></pre> </code></pre>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../00_Prepare_everything/" class="btn btn-neutral float-left" title="Before You Start"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../02_Concept_of_LinkHandler/" class="btn btn-neutral float-right" title="Concept of the LinkHandler">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../02_Concept_of_LinkHandler/" class="btn btn-neutral float-right" title="Concept of the LinkHandler">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../00_Prepare_everything/" class="btn btn-neutral" title="Before You Start"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -293,7 +317,7 @@ items like a regular web page, but all the others as an AJAX request.</p>
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

160
02_Concept_of_LinkHandler/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Concept of the LinkHandler - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -32,32 +36,34 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Concept of the LinkHandler</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Concept of the LinkHandler</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#important-notes-about-linkhandler">Important notes about LinkHandler</a> <li class="toctree-l2"><a class="reference internal" href="#important-notes-about-linkhandler">Important notes about LinkHandler</a>
</li> </li>
@ -72,58 +78,68 @@
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Concept of the LinkHandler</li>
<li>Concept of the LinkHandler</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="concept-of-the-linkhandler">Concept of the LinkHandler</h1> <h1 id="concept-of-the-linkhandler">Concept of the LinkHandler</h1>
<p>The <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandler.html">LinkHandler</a> <p>The <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandler.html">LinkHandler</a>
@ -193,21 +209,29 @@ These work like regular ListLinkHandler, except that you don't have to implement
and <code>getId()</code> when overriding <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/SearchQueryHandlerFactory.html">SearchQueryHandlerFactory</a>.</p> and <code>getId()</code> when overriding <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/SearchQueryHandlerFactory.html">SearchQueryHandlerFactory</a>.</p>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../01_Concept_of_the_extractor/" class="btn btn-neutral float-left" title="Concept of the Extractor"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../03_Implement_a_service/" class="btn btn-neutral float-right" title="Implementing a Service">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../03_Implement_a_service/" class="btn btn-neutral float-right" title="Implementing a Service">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../01_Concept_of_the_extractor/" class="btn btn-neutral" title="Concept of the Extractor"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -215,7 +239,7 @@ and <code>getId()</code> when overriding <a href="https://teamnewpipe.github.io/
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

160
03_Implement_a_service/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Implementing a Service - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -32,36 +36,38 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Implementing a Service</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Implementing a Service</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#required-and-optional-parts">Required and Optional Parts</a> <li class="toctree-l2"><a class="reference internal" href="#required-and-optional-parts">Required and Optional Parts</a>
</li> </li>
@ -84,54 +90,64 @@
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Implementing a Service</li>
<li>Implementing a Service</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="implementing-a-service">Implementing a Service</h1> <h1 id="implementing-a-service">Implementing a Service</h1>
<p>Services, or better service connectors, are the parts of NewPipe which communicate with an actual service like YouTube. <p>Services, or better service connectors, are the parts of NewPipe which communicate with an actual service like YouTube.
@ -280,21 +296,29 @@ public KioskList getKioskList() throws ExtractionException {
</ul> </ul>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../02_Concept_of_LinkHandler/" class="btn btn-neutral float-left" title="Concept of the LinkHandler"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../04_Run_changes_in_App/" class="btn btn-neutral float-right" title="Testing Your Changes in the App">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../04_Run_changes_in_App/" class="btn btn-neutral float-right" title="Testing Your Changes in the App">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../02_Concept_of_LinkHandler/" class="btn btn-neutral" title="Concept of the LinkHandler"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -302,7 +326,7 @@ public KioskList getKioskList() throws ExtractionException {
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

160
04_Run_changes_in_App/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Testing Your Changes in the App - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -32,40 +36,42 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Testing Your Changes in the App</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Testing Your Changes in the App</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#setup-android-studio">Setup Android Studio</a> <li class="toctree-l2"><a class="reference internal" href="#setup-android-studio">Setup Android Studio</a>
</li> </li>
@ -82,50 +88,60 @@
<li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a> <li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Testing Your Changes in the App</li>
<li>Testing Your Changes in the App</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<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
@ -179,21 +195,29 @@ click on that little paper symbol next to the <code>GET IT</code> button. If it'
<img alt="jitpack failed to build" src="../img/jitpack_fail.png" /></p> <img alt="jitpack failed to build" src="../img/jitpack_fail.png" /></p>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../03_Implement_a_service/" class="btn btn-neutral float-left" title="Implementing a Service"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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="../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>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -201,7 +225,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" aria-label="Versions"> <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">

160
05_Mock_tests/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Mock Tests - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Mock Tests - 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" />
@ -32,44 +36,46 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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 class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Mock Tests</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Mock Tests</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#multiple-downloader-implementations">Multiple downloader implementations</a> <li class="toctree-l2"><a class="reference internal" href="#multiple-downloader-implementations">Multiple downloader implementations</a>
<ul> <ul>
@ -80,46 +86,56 @@
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Mock Tests</li>
<li>Mock Tests</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="mock-tests">Mock Tests</h1> <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. <p>A web crawler is, by its very nature, dependent on the external service which it is crawling.
@ -167,21 +183,29 @@ It skips the tests in the CI pipeline if they are not run with mocks.</p>
</code></pre> </code></pre>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../04_Run_changes_in_App/" class="btn btn-neutral float-left" title="Testing Your Changes in the App"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<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="../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> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -189,7 +213,7 @@ It skips the tests in the CI pipeline if they are not run with mocks.</p>
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

160
06_releasing/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Releasing a New NewPipe Version - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -32,48 +36,50 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a> <li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
</li> </li>
</ul> </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">
<li class="toctree-l2"><a class="reference internal" href="#differences-between-regular-and-hotfix-releases">Differences Between Regular and Hotfix Releases</a> <li class="toctree-l2"><a class="reference internal" href="#differences-between-regular-and-hotfix-releases">Differences Between Regular and Hotfix Releases</a>
</li> </li>
@ -112,42 +118,52 @@
<li class="toctree-l2"><a class="reference internal" href="#publish-on-f-droid">Publish on F-Droid</a> <li class="toctree-l2"><a class="reference internal" href="#publish-on-f-droid">Publish on F-Droid</a>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Releasing a New NewPipe Version</li>
<li>Releasing a New NewPipe Version</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="releasing-a-new-newpipe-version">Releasing a New NewPipe Version</h1> <h1 id="releasing-a-new-newpipe-version">Releasing a New NewPipe Version</h1>
<p>This site is meant for those who want to maintain NewPipe, or just want to know how releasing works.</p> <p>This site is meant for those who want to maintain NewPipe, or just want to know how releasing works.</p>
@ -353,21 +369,29 @@ An example commit containing all required changes can be found <a href="https://
</ol> </ol>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../05_Mock_tests/" class="btn btn-neutral float-left" title="Mock Tests"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../07_release_instructions/" class="btn btn-neutral float-right" title="Release instructions for normal releases">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../07_release_instructions/" class="btn btn-neutral float-right" title="Release instructions for normal releases">Next <span class="icon icon-circle-arrow-right"></span></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>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -375,7 +399,7 @@ An example commit containing all required changes can be found <a href="https://
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

202
07_release_instructions/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Release instructions for normal releases - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Release instructions for normal releases - 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" />
@ -32,52 +36,54 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</a> <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">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Release instructions for normal releases</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Release instructions for normal releases</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#preliminary-steps">Preliminary steps</a> <li class="toctree-l2"><a class="reference internal" href="#preliminary-steps">Preliminary steps</a>
<ul> <ul>
@ -118,38 +124,48 @@
<li class="toctree-l2"><a class="reference internal" href="#blog-post">Blog post</a> <li class="toctree-l2"><a class="reference internal" href="#blog-post">Blog post</a>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Release instructions for normal releases</li>
<li>Release instructions for normal releases</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="release-instructions-for-normal-releases">Release instructions for normal releases</h1> <h1 id="release-instructions-for-normal-releases">Release instructions for normal releases</h1>
<p>This page contains detailed instructions for normal releases. Refer to <a href="../06_releasing">Releasing a New NewPipe Version</a> for other information about releases.</p> <p>This page contains detailed instructions for normal releases. Refer to <a href="../06_releasing">Releasing a New NewPipe Version</a> for other information about releases.</p>
@ -158,6 +174,7 @@
<ul> <ul>
<li>Have admin rights on Weblate<ul> <li>Have admin rights on Weblate<ul>
<li>You should be able to access <a href="https://hosted.weblate.org/projects/newpipe/#repository">Weblate's Maintenance page</a></li> <li>You should be able to access <a href="https://hosted.weblate.org/projects/newpipe/#repository">Weblate's Maintenance page</a></li>
<li>Tip: if the correct page does not show up when clicking that URL, make sure you are logged in ;-)</li>
</ul> </ul>
</li> </li>
<li>Have at least maintainer rights on the NewPipe and NewPipeExtractor repos</li> <li>Have at least maintainer rights on the NewPipe and NewPipeExtractor repos</li>
@ -249,7 +266,10 @@ Fixed
<li>Use English verbs as if you were asking someone to do something, so for example use "Fix abc" and not "Fixed abc"; this allows saving a few characters and using a consistent style</li> <li>Use English verbs as if you were asking someone to do something, so for example use "Fix abc" and not "Fixed abc"; this allows saving a few characters and using a consistent style</li>
<li>Prepend <code>[SERVICE]</code> to service-only changes (e.g. "• [YouTube] Add mixes")</li> <li>Prepend <code>[SERVICE]</code> to service-only changes (e.g. "• [YouTube] Add mixes")</li>
<li>Summarize only the most important changes from the draft release <a href="https://github.com/TeamNewPipe/NewPipe/releases">kept on GitHub</a> (it contains all merged pull requests)</li> <li>Summarize only the most important changes from the draft release <a href="https://github.com/TeamNewPipe/NewPipe/releases">kept on GitHub</a> (it contains all merged pull requests)</li>
<li>Make sure the file size is <strong>at most 500 bytes</strong>, in order to <strong>fit <a href="https://f-droid.org/en/docs/All_About_Descriptions_Graphics_and_Screenshots/#fastlane-structure">F-Droid's changelog size limit</a> (!)</strong></li> <li>Make sure the file size is <strong>at most 500 bytes</strong>, in order to <strong>fit <a href="https://f-droid.org/en/docs/All_About_Descriptions_Graphics_and_Screenshots/#fastlane-structure">F-Droid's changelog size limit</a> (!)</strong><ul>
<li>Tip: removing the newline at the end of the file saves 1 byte ;-)</li>
</ul>
</li>
<li>Commit the file on the <code>dev</code> branch (try to stick to the provided commit message template)<ul> <li>Commit the file on the <code>dev</code> branch (try to stick to the provided commit message template)<ul>
<li><code>git add fastlane/metadata/android/en-US/changelogs/NEW_VERSION_CODE.txt</code></li> <li><code>git add fastlane/metadata/android/en-US/changelogs/NEW_VERSION_CODE.txt</code></li>
<li><code>git commit -m "Add changelog for vX.X.X (NEW_VERSION_CODE)"</code></li> <li><code>git commit -m "Add changelog for vX.X.X (NEW_VERSION_CODE)"</code></li>
@ -276,6 +296,7 @@ Fixed
<h2 id="creating-the-release-branch">Creating the release branch</h2> <h2 id="creating-the-release-branch">Creating the release branch</h2>
<ul> <ul>
<li>Create a new branch starting from <code>dev</code>, named <code>release-X.X.X</code>, and switch to it<ul> <li>Create a new branch starting from <code>dev</code>, named <code>release-X.X.X</code>, and switch to it<ul>
<li><code>git checkout dev</code></li>
<li><code>git checkout -b release-X.X.X</code></li> <li><code>git checkout -b release-X.X.X</code></li>
</ul> </ul>
</li> </li>
@ -299,7 +320,7 @@ Fixed
</ul> </ul>
</li> </li>
<li>Push the newly created branch to the NewPipe repo<ul> <li>Push the newly created branch to the NewPipe repo<ul>
<li><code>git push upstream release-X.X.X</code></li> <li><code>git push origin release-X.X.X</code></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -313,7 +334,7 @@ Fixed
<li>The PR title should be "Release vX.X.X (NEW_VERSION_CODE)"</li> <li>The PR title should be "Release vX.X.X (NEW_VERSION_CODE)"</li>
<li>Remove the entire PR template, and instead put these two lines in the description (the <code>ISSUE_NUMBER</code> will be replaced later):</li> <li>Remove the entire PR template, and instead put these two lines in the description (the <code>ISSUE_NUMBER</code> will be replaced later):</li>
</ul> </ul>
<pre><code class="language-md">Do not report regressions here, but rather in the corresponding issue: #ISSUE_NUMBER <pre><code class="language-md">Do **not** report regressions here, but rather in the corresponding issue: #ISSUE_NUMBER
The changelog is also there. The changelog is also there.
</code></pre> </code></pre>
<ul> <ul>
@ -329,16 +350,29 @@ The changelog is also there.
</li> </li>
<li>The issue title should be "Release vX.X.X (please TEST!)"</li> <li>The issue title should be "Release vX.X.X (please TEST!)"</li>
<li>The issue should have some sections, in the same order as provided below, with <code>##</code> before titles</li> <li>The issue should have some sections, in the same order as provided below, with <code>##</code> before titles</li>
<li>The <code>## Testing for regressions</code> section should contain the following lines; more information about how to obtain the APK are given at <a href="testing-apks">Testing APKs</a></li> <li>The <code>## Testing for regressions</code> section should contain the following lines; more information about how to obtain the APK are given at <a href="#testing-apks">Testing APKs</a></li>
</ul> </ul>
<pre><code class="language-md">Debug APK (built by our CI in #PR_NUMBER): ... <pre><code class="language-md">Debug APK (built by our CI in #PR_NUMBER): ...
Please report **only regressions** (i.e. new issues) here, not issues that were already present in the previous release! Please report **only regressions** (i.e. new issues) here, not issues that were already present in previous releases!
</code></pre> </code></pre>
<ul> <ul>
<li>An optional <code>## TODO</code> section should contain a list of things that still need to be done before releasing, for example regressions that need to be fixed, or a reminder to merge the Weblate changelogs before releasing (use <code>- [ ]</code> to create checkbox lists)</li> <li>An optional <code>## TODO</code> section should contain a list of things that still need to be done before releasing, for example regressions that need to be fixed, or a reminder to merge the Weblate changelogs before releasing (use <code>- [ ]</code> to create checkbox lists)</li>
<li>The <code>## NewPipeExtractor version</code> should contain a link to the NewPipeExtractor release this new NewPipe version will ship with (i.e. the one set in <a href="#creating-the-release-branch">Creating the release branch</a>)</li> <li>The <code>## NewPipeExtractor version</code> section should contain a link to the NewPipeExtractor release this new NewPipe version will ship with (i.e. the one set in <a href="#creating-the-release-branch">Creating the release branch</a>); choose one of these lines as a template</li>
<li>Copy the draft Markdown changelog <a href="https://github.com/TeamNewPipe/NewPipe/releases">kept on GitHub</a> (you finalized it earlier in <a href="#create-a-changelog">Create a changelog</a>) to the clipboard and paste it under the <code>## App changelog</code> section</li> </ul>
<pre><code class="language-md">This version of NewPipe will ship with [NewPipeExtractor version NPE_VERSION](https://github.com/TeamNewPipe/NewPipeExtractor/releases/tag/NPE_VERSION)
This version of NewPipe will ship with [NewPipeExtractor commit FIRST_7_DIGITS_OF_NPE_COMMIT](https://github.com/TeamNewPipe/NewPipeExtractor/commit/NPE_COMMIT)
</code></pre>
<ul>
<li>Create the <code>App changelog</code> section using the template below. Copy the draft Markdown changelog <a href="https://github.com/TeamNewPipe/NewPipe/releases">kept on GitHub</a> (you finalized it earlier in <a href="#create-a-changelog">Create a changelog</a>) to the clipboard and paste it where specified below (make sure to leave a newline above, otherwise Markdown breaks):</li>
</ul>
<pre><code class="language-md">&lt;details&gt;&lt;summary&gt;&lt;h2&gt;App changelog &lt;/h2&gt;&lt;/summary&gt;&lt;p&gt;
INSERT_COPIED_CHANGELOG_HERE
&lt;/details&gt;
</code></pre>
<ul>
<li>Once you have created the issue, pin it using the "Pin issue" button on the right</li> <li>Once you have created the issue, pin it using the "Pin issue" button on the right</li>
<li>Update the <code>ISSUE_NUMBER</code> in the pull request description</li>
<li><em>Check out <a href="https://github.com/TeamNewPipe/NewPipe/issues/8230">#8230</a> for reference</em></li> <li><em>Check out <a href="https://github.com/TeamNewPipe/NewPipe/issues/8230">#8230</a> for reference</em></li>
</ul> </ul>
<h2 id="testing-apks">Testing APKs</h2> <h2 id="testing-apks">Testing APKs</h2>
@ -352,10 +386,14 @@ Please report **only regressions** (i.e. new issues) here, not issues that were
<p>Sometimes it might be needed to also provide a release APK. In this case follow the same steps as above, with these differences:</p> <p>Sometimes it might be needed to also provide a release APK. In this case follow the same steps as above, with these differences:</p>
<ul> <ul>
<li>Make sure you are on the <code>release-X.X.X</code> branch</li> <li>Make sure you are on the <code>release-X.X.X</code> branch</li>
<li>Build the <strong>release</strong> APK yourself in Android Studio and sign it with your keys</li> <li>Build the <strong>release</strong> APK yourself in Android Studio and sign it with your keys<ul>
<li><em>Temporarily</em> edit the <code>app/build.gradle</code> file and add <code>System.properties.put("packageSuffix", "vX_X_X")</code> at the top of the <code>android -&gt; buildTypes -&gt; release</code> block, which ensures that the application has a different package name than the official one</li>
<li>Build and sign an APK via "Build -&gt; Generate Signed Bundle / APK..."</li>
</ul>
</li>
<li>Make sure it installs correctly on your device</li> <li>Make sure it installs correctly on your device</li>
<li>Use this naming scheme: <code>NewPipe_vX.X.X_RC1_release.apk</code></li> <li>Use this naming scheme: <code>NewPipe_vX.X.X_RC1_release.apk</code></li>
<li>Add a line to the <code>## Testing for regressions</code> section, of this form: <code>Debug APK (built and signed by @YOUR_GITHUB_USERNAME): ...</code></li> <li>Add a line to the <code>## Testing for regressions</code> section, of this form: <code>Release APK (built and signed by @YOUR_GITHUB_USERNAME): ...</code></li>
</ul> </ul>
<h2 id="taking-care-of-regressions-quickfixes">Taking care of regressions (quickfixes)</h2> <h2 id="taking-care-of-regressions-quickfixes">Taking care of regressions (quickfixes)</h2>
<p>The release issue and pull request should stay open for <strong>roughly one week</strong>, so that people can test the provided APKs and give feedback. If a <em>regression</em> is reported by some user, it should possibly be solved before releasing, otherwise the app would become more broken after each release. A <em>regression</em> is a bug now present in some code that used to run well in the last release, but was then modified in this release (supposedly to fix something else) and is now broken. So the following do not classify as regressions: some videos stop working because YouTube made some changes; the newly introduced big feature XYZ is still not perfect and has some bugs; a random crash reproducible also on previous versions... You get the point. Before releasing, try to fix any regressions that are reported, but avoid fixing non-regressions, since those should be treated with the same care and attention as all other issues. As a Release Manager, you might be required to fix regressions, so plan your release at a time when you are available.</p> <p>The release issue and pull request should stay open for <strong>roughly one week</strong>, so that people can test the provided APKs and give feedback. If a <em>regression</em> is reported by some user, it should possibly be solved before releasing, otherwise the app would become more broken after each release. A <em>regression</em> is a bug now present in some code that used to run well in the last release, but was then modified in this release (supposedly to fix something else) and is now broken. So the following do not classify as regressions: some videos stop working because YouTube made some changes; the newly introduced big feature XYZ is still not perfect and has some bugs; a random crash reproducible also on previous versions... You get the point. Before releasing, try to fix any regressions that are reported, but avoid fixing non-regressions, since those should be treated with the same care and attention as all other issues. As a Release Manager, you might be required to fix regressions, so plan your release at a time when you are available.</p>
@ -457,7 +495,7 @@ Please report **only regressions** (i.e. new issues) here, not issues that were
<li>Go to the draft changelog <a href="https://github.com/TeamNewPipe/NewPipe/releases">kept on GitHub</a></li> <li>Go to the draft changelog <a href="https://github.com/TeamNewPipe/NewPipe/releases">kept on GitHub</a></li>
<li>Set <code>vX.X.X</code> as the tag name</li> <li>Set <code>vX.X.X</code> as the tag name</li>
<li>Set <code>vX.X.X</code> as the release title</li> <li>Set <code>vX.X.X</code> as the release title</li>
<li>Set <code>dev</code> as the "Target:" branch</li> <li>Set <code>master</code> as the "Target:" branch</li>
<li>Attach the signed APK @TheAssassin sent you</li> <li>Attach the signed APK @TheAssassin sent you</li>
<li>Publish the release</li> <li>Publish the release</li>
<li>Profit :-D</li> <li>Profit :-D</li>
@ -472,21 +510,29 @@ Please report **only regressions** (i.e. new issues) here, not issues that were
</ul> </ul>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../06_releasing/" class="btn btn-neutral float-left" title="Releasing a New NewPipe Version"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../08_documentation/" class="btn btn-neutral float-right" title="About This Documentation">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../08_documentation/" class="btn btn-neutral float-right" title="About This Documentation">Next <span class="icon icon-circle-arrow-right"></span></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>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -494,7 +540,7 @@ Please report **only regressions** (i.e. new issues) here, not issues that were
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

160
08_documentation/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>About This Documentation - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -32,56 +36,58 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">About This Documentation</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">About This Documentation</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a> <li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a>
</li> </li>
@ -100,34 +106,44 @@
<li class="toctree-l2"><a class="reference internal" href="#write-and-deploy">Write and Deploy</a> <li class="toctree-l2"><a class="reference internal" href="#write-and-deploy">Write and Deploy</a>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>About This Documentation</li>
<li>About This Documentation</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="about-this-documentation">About This Documentation</h1> <h1 id="about-this-documentation">About This Documentation</h1>
<p>The documentation you are currently reading was written using <a href="https://www.mkdocs.org/">mkdocs</a>. It is a tool that will generate a static website based on <a href="https://www.markdownguide.org/">markdown</a> files. Markdown has the advantage that it is simple to read and write, and that there are several tools that can translate a markdown file into languages like HTML or LaTeX.</p> <p>The documentation you are currently reading was written using <a href="https://www.mkdocs.org/">mkdocs</a>. It is a tool that will generate a static website based on <a href="https://www.markdownguide.org/">markdown</a> files. Markdown has the advantage that it is simple to read and write, and that there are several tools that can translate a markdown file into languages like HTML or LaTeX.</p>
@ -183,21 +199,29 @@ or run <code>sudo pip3 install mkdocs</code> to install mkdocs systemwide. Last
<p>If you want to deploy the page so it will be up to date at the <a href="https://teamnewpipe.github.io/documentation/">GitHub pages</a>, simply type <code>mkdocs gh-deploy</code>. However, please be aware that this will not push your changes to the <code>master</code> branch of the repository. So, you still have to commit and push your changes to the actual git repository of this documentation. <em>Please be aware that only privileged maintainers can do this.</em></p> <p>If you want to deploy the page so it will be up to date at the <a href="https://teamnewpipe.github.io/documentation/">GitHub pages</a>, simply type <code>mkdocs gh-deploy</code>. However, please be aware that this will not push your changes to the <code>master</code> branch of the repository. So, you still have to commit and push your changes to the actual git repository of this documentation. <em>Please be aware that only privileged maintainers can do this.</em></p>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../07_release_instructions/" class="btn btn-neutral float-left" title="Release instructions for normal releases"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../09_maintainers_view/" class="btn btn-neutral float-right" title="Maintainers' Section">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="../09_maintainers_view/" class="btn btn-neutral float-right" title="Maintainers' Section">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../07_release_instructions/" class="btn btn-neutral" title="Release instructions for normal releases"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -205,7 +229,7 @@ or run <code>sudo pip3 install mkdocs</code> to install mkdocs systemwide. Last
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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
09_maintainers_view/index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>Maintainers' Section - NewPipe Development Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<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" />
@ -18,7 +22,7 @@
<script> <script>
// Current page data // Current page data
var mkdocs_page_name = "Maintainers\u0027 Section"; var mkdocs_page_name = "Maintainers' Section";
var mkdocs_page_input_path = "09_maintainers_view.md"; var mkdocs_page_input_path = "09_maintainers_view.md";
var mkdocs_page_url = null; var mkdocs_page_url = null;
</script> </script>
@ -32,60 +36,62 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href=".." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Maintainers' Section</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Maintainers' Section</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#keep-it-streamlined">Keep it Streamlined</a> <li class="toctree-l2"><a class="reference internal" href="#keep-it-streamlined">Keep it Streamlined</a>
</li> </li>
@ -106,30 +112,40 @@
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="..">Docs</a> &raquo;</li>
<li>Maintainers' Section</li>
<li>Maintainers' Section</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="maintainers-section">Maintainers' Section</h1> <h1 id="maintainers-section">Maintainers' Section</h1>
<p>These are some basic principles that we want maintainers to follow when maintaining NewPipe.</p> <p>These are some basic principles that we want maintainers to follow when maintaining NewPipe.</p>
@ -229,20 +245,27 @@ If there are conflicts when rebasing weblate, resolve them.</p>
<p>Push the changes to NewPipe's <code>dev</code> branch, <a href="#update-weblate">update Weblate</a> and unlock it.</p> <p>Push the changes to NewPipe's <code>dev</code> branch, <a href="#update-weblate">update Weblate</a> and unlock it.</p>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<a href="../08_documentation/" class="btn btn-neutral float-left" title="About This Documentation"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../08_documentation/" class="btn btn-neutral" title="About This Documentation"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -250,7 +273,7 @@ If there are conflicts when rebasing weblate, resolve them.</p>
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

168
404.html
View File

@ -1,103 +1,118 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>NewPipe Development Documentation</title>
<link rel="stylesheet" href="/css/theme.css" />
<link rel="stylesheet" href="/css/theme_extra.css" /> <link rel="shortcut icon" href="/img/favicon.ico">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" /> <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" />
<script src="/js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]> <link rel="stylesheet" href="/css/theme.css" />
<script src="/js/html5shiv.min.js"></script> <link rel="stylesheet" href="/css/theme_extra.css" />
<![endif]--> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head> </head>
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href="/." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="/.">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="/00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="/01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="/02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="/03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="/05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="/07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="/08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="/09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="/09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/.">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="/." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="/.">Docs</a> &raquo;</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="404-page-not-found">404</h1> <h1 id="404-page-not-found">404</h1>
@ -106,17 +121,20 @@
</div> </div>
</div><footer> </div>
<footer>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -124,7 +142,7 @@
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

13
css/theme.css
View File

File diff suppressed because one or more lines are too long

30
css/theme_extra.css
View File

@ -21,11 +21,11 @@
* https://github.com/mkdocs/mkdocs/issues/233 * https://github.com/mkdocs/mkdocs/issues/233
*/ */
.rst-content pre code { .rst-content pre code {
white-space: pre; white-space: pre;
word-wrap: normal; word-wrap: normal;
display: block; display: block;
padding: 12px; padding: 12px;
font-size: 12px; font-size: 12px;
} }
/** /**
@ -77,9 +77,9 @@ pre .cs, pre .c {
* https://github.com/mkdocs/mkdocs/issues/319 * https://github.com/mkdocs/mkdocs/issues/319
*/ */
.rst-content .no-highlight { .rst-content .no-highlight {
display: block; display: block;
padding: 0.5em; padding: 0.5em;
color: #333; color: #333;
} }
@ -113,11 +113,11 @@ form .search-query {
* https://github.com/mkdocs/mkdocs/issues/656 * https://github.com/mkdocs/mkdocs/issues/656
*/ */
.rst-content .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);
background: #f8fbfd; background: #f8fbfd;
background: rgba(255, 255, 255, 0.7); background: rgba(255, 255, 255, 0.7);
} }
/* /*
@ -135,8 +135,8 @@ form .search-query {
} }
td, th { 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.

0
css/fonts/lato-bold.woff → fonts/Lato/lato-bold.woff
View File

0
css/fonts/lato-bold.woff2 → fonts/Lato/lato-bold.woff2
View File

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.

0
css/fonts/lato-bold-italic.woff → fonts/Lato/lato-bolditalic.woff
View File

0
css/fonts/lato-bold-italic.woff2 → fonts/Lato/lato-bolditalic.woff2
View File

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.

0
css/fonts/lato-normal-italic.woff → fonts/Lato/lato-italic.woff
View File

0
css/fonts/lato-normal-italic.woff2 → fonts/Lato/lato-italic.woff2
View File

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.

0
css/fonts/lato-normal.woff → fonts/Lato/lato-regular.woff
View File

0
css/fonts/lato-normal.woff2 → fonts/Lato/lato-regular.woff2
View File

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.

0
css/fonts/Roboto-Slab-Bold.woff → fonts/RobotoSlab/roboto-slab-v7-bold.woff
View File

0
css/fonts/Roboto-Slab-Bold.woff2 → fonts/RobotoSlab/roboto-slab-v7-bold.woff2
View File

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.

0
css/fonts/Roboto-Slab-Regular.woff → fonts/RobotoSlab/roboto-slab-v7-regular.woff
View File

0
css/fonts/Roboto-Slab-Regular.woff2 → fonts/RobotoSlab/roboto-slab-v7-regular.woff2
View File

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

Binary file not shown.

0
css/fonts/fontawesome-webfont.eot → fonts/fontawesome-webfont.eot
View File

0
css/fonts/fontawesome-webfont.svg → fonts/fontawesome-webfont.svg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 434 KiB

After

Width:  |  Height:  |  Size: 434 KiB

0
css/fonts/fontawesome-webfont.ttf → fonts/fontawesome-webfont.ttf
View File

0
css/fonts/fontawesome-webfont.woff → fonts/fontawesome-webfont.woff
View File

0
css/fonts/fontawesome-webfont.woff2 → fonts/fontawesome-webfont.woff2
View File

161
index.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="None" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="img/favicon.ico" /> <meta name="description" content="None">
<title>NewPipe Development Documentation</title>
<link rel="shortcut icon" href="img/favicon.ico">
<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" />
@ -32,88 +36,100 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href="." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</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>
</ul> </ul>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href=".">Docs</a> &raquo;</li>
<li>Welcome to the NewPipe Development Docs</li>
<li>Welcome to the NewPipe Development Docs</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="welcome-to-the-newpipe-development-docs">Welcome to the NewPipe Development Docs</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>
@ -126,20 +142,27 @@ It is an addition to our auto generated <a href="https://teamnewpipe.github.io/N
It focuses on making it possible for the creator of a scraper for a streaming service to create the best outcome with the least amount of written code.</p> It focuses on making it possible for the creator of a scraper for a streaming service to create the best outcome with the least amount of written code.</p>
</div> </div>
</div><footer> </div>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="00_Prepare_everything/" class="btn btn-neutral float-right" title="Before You Start">Next <span class="icon icon-circle-arrow-right"></span></a> <a href="00_Prepare_everything/" class="btn btn-neutral float-right" title="Before You Start">Next <span class="icon icon-circle-arrow-right"></span></a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -147,7 +170,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" aria-label="Versions"> <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">
@ -170,6 +193,6 @@ It focuses on making it possible for the creator of a scraper for a streaming se
</html> </html>
<!-- <!--
MkDocs version : 1.3.1 MkDocs version : 1.2.3
Build Date UTC : 2022-08-14 15:37:33.940953+00:00 Build Date UTC : 2022-08-28 11:42:37.836548+00:00
--> -->

4
js/html5shiv.min.js vendored
View File

@ -1,4 +0,0 @@
/**
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
*/
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);

4
js/jquery-2.1.1.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

2
js/jquery-3.6.0.min.js vendored
View File

File diff suppressed because one or more lines are too long

1
js/modernizr-2.8.3.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

5
js/theme.js
View File

File diff suppressed because one or more lines are too long

148
search.html
View File

@ -1,11 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<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" />
<title>NewPipe Development Documentation</title>
<link rel="shortcut icon" href="./img/favicon.ico">
<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" />
@ -25,83 +29,94 @@
<body class="wy-body-for-nav" role="document"> <body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<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 Development Documentation <a href="./." class="icon icon-home"> NewPipe Development Documentation</a>
</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" />
</form> </form>
</div> </div>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <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 the NewPipe Development Docs</a> <li class="toctree-l1"><a class="reference internal" href="./.">Welcome to the NewPipe Development Docs</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./00_Prepare_everything/">Before You Start</a> <li class="toctree-l1"><a class="reference internal" href="./00_Prepare_everything/">Before You Start</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./01_Concept_of_the_extractor/">Concept of the Extractor</a> <li class="toctree-l1"><a class="reference internal" href="./01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./02_Concept_of_LinkHandler/">Concept of the LinkHandler</a> <li class="toctree-l1"><a class="reference internal" href="./02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./03_Implement_a_service/">Implementing a Service</a> <li class="toctree-l1"><a class="reference internal" href="./03_Implement_a_service/">Implementing a Service</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<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> <ul>
<li class="toctree-l1"><a class="reference internal" href="./05_Mock_tests/">Mock Tests</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_releasing/">Releasing a New NewPipe Version</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_release_instructions/">Release instructions for normal releases</a> <li class="toctree-l1"><a class="reference internal" href="./07_release_instructions/">Release instructions for normal releases</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./08_documentation/">About This Documentation</a> <li class="toctree-l1"><a class="reference internal" href="./08_documentation/">About This Documentation</a>
</li> </li>
</ul> </ul>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="./09_maintainers_view/">Maintainers' Section</a> <li class="toctree-l1"><a class="reference internal" href="./09_maintainers_view/">Maintainers' Section</a>
</li> </li>
</ul> </ul>
</div> </div>
</div> </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">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="./.">NewPipe Development Documentation</a> <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> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="./." class="icon icon-home" alt="Docs"></a> &raquo;</li> <li><a href="./.">Docs</a> &raquo;</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody"> <div role="main">
<div class="section">
<h1 id="search">Search Results</h1> <h1 id="search">Search Results</h1>
@ -117,17 +132,20 @@
</div> </div>
</div><footer> </div>
<footer>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<!-- Copyright etc --> <!-- Copyright etc -->
</div> </div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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>
</div> </div>
@ -135,7 +153,7 @@
</div> </div>
<div class="rst-versions" role="note" aria-label="Versions"> <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">

9
search/main.js
View File

@ -21,15 +21,8 @@ function joinUrl (base, path) {
return base + "/" + path; return base + "/" + path;
} }
function escapeHtml (value) {
return value.replace(/&/g, '&amp;')
.replace(/"/g, '&quot;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;');
}
function formatResult (location, title, summary) { function formatResult (location, title, summary) {
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>'; return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ title + '</a></h3><p>' + summary +'</p></article>';
} }
function displayResults (results) { function displayResults (results) {

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

22
sitemap.xml
View File

@ -2,57 +2,57 @@
<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>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-08-14</lastmod> <lastmod>2022-08-28</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
</urlset> </urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.