2018-02-20 22:51:11 +00:00
<!DOCTYPE html>
2022-08-28 12:50:59 +00:00
< html class = "writer-html5" lang = "en" >
2018-02-20 22:51:11 +00:00
< head >
2022-08-28 12:50:59 +00:00
< meta charset = "utf-8" / >
< 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" / >
< link rel = "shortcut icon" href = "img/favicon.ico" / >
< title > NewPipe Development Documentation< / title >
2018-09-08 17:06:35 +00:00
<!-- local fonts -->
2018-02-23 20:18:58 +00:00
< link rel = "stylesheet" href = "./css/local_fonts.css" type = "text/css" / >
2018-02-20 22:51:11 +00:00
< link rel = "stylesheet" href = "./css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "./css/theme_extra.css" type = "text/css" / >
2019-04-07 17:32:19 +00:00
< link rel = "stylesheet" href = "./css/theme_child.css" type = "text/css" / >
2018-09-08 17:06:35 +00:00
<!-- local code syntax highlighting -->
< link rel = "stylesheet" href = "./css/github.min.css" type = "text/css" / >
2018-02-23 20:18:58 +00:00
< link rel = "stylesheet" href = "./css/highlight.css" type = "text/css" / >
2018-02-20 22:51:11 +00:00
< script >
// Current page data
2022-02-11 21:16:29 +00:00
var mkdocs_page_name = "Welcome to the NewPipe Development Docs";
2018-02-22 18:22:22 +00:00
var mkdocs_page_input_path = "index.md";
2018-09-01 13:48:12 +00:00
var mkdocs_page_url = null;
2018-02-20 22:51:11 +00:00
< / script >
2018-09-01 13:48:12 +00:00
< script src = "js/jquery-2.1.1.min.js" defer > < / script >
< script src = "js/modernizr-2.8.3.min.js" defer > < / script >
2018-09-08 17:06:35 +00:00
< script src = "./js/highlight.min.js" > < / script >
2018-09-01 13:48:12 +00:00
< script > hljs . initHighlightingOnLoad ( ) ; < / script >
2018-02-20 22:51:11 +00:00
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side stickynav" >
2020-08-13 00:02:52 +00:00
< div class = "wy-side-scroll" >
2018-02-20 22:51:11 +00:00
< div class = "wy-side-nav-search" >
2022-08-28 12:50:59 +00:00
< a href = "." class = "icon icon-home" > NewPipe Development Documentation
< / a > < div role = "search" >
2018-02-20 22:51:11 +00:00
< form id = "rtd-search-form" class = "wy-form" action = "./search.html" method = "get" >
2023-08-13 18:03:19 +00:00
< input type = "text" name = "q" placeholder = "Search docs" aria-label = "Search docs" title = "Type search term here" / >
2018-02-20 22:51:11 +00:00
< / form >
< / div >
< / div >
2022-08-28 12:50:59 +00:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal current" href = "." > Welcome to the NewPipe Development Docs< / a >
2020-08-13 00:02:52 +00:00
< ul class = "current" >
< li class = "toctree-l2" > < a class = "reference internal" href = "#introduction" > Introduction< / a >
< / li >
2018-02-22 18:22:22 +00:00
< / ul >
2022-08-28 12:50:59 +00:00
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "00_Prepare_everything/" > Before You Start< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "01_Concept_of_the_extractor/" > Concept of the Extractor< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "02_Concept_of_LinkHandler/" > Concept of the LinkHandler< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "03_Implement_a_service/" > Implementing a Service< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "04_Run_changes_in_App/" > Testing Your Changes in the App< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "05_Mock_tests/" > Mock Tests< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "06_releasing/" > Releasing a New NewPipe Version< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "07_release_instructions/" > Release instructions for normal releases< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "08_documentation/" > About This Documentation< / a >
< / li >
< / ul >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "09_maintainers_view/" > Maintainers' Section< / a >
< / li >
< / ul >
2018-02-20 22:51:11 +00:00
< / div >
2020-08-13 00:02:52 +00:00
< / div >
2018-02-20 22:51:11 +00:00
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
2022-08-28 12:50:59 +00:00
< 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 >
2018-02-20 22:51:11 +00:00
< / nav >
< div class = "wy-nav-content" >
2022-08-28 12:50:59 +00:00
< div class = "rst-content" > < div role = "navigation" aria-label = "breadcrumbs navigation" >
2018-02-20 22:51:11 +00:00
< ul class = "wy-breadcrumbs" >
2023-08-13 18:03:19 +00:00
< li > < a href = "." class = "icon icon-home" aria-label = "Docs" > < / a > » < / li >
< li class = "breadcrumb-item active" > Welcome to the NewPipe Development Docs< / li >
2018-02-20 22:51:11 +00:00
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
2022-08-28 12:50:59 +00:00
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div class = "section" itemprop = "articleBody" >
2018-02-20 22:51:11 +00:00
2022-02-11 21:16:29 +00:00
< h1 id = "welcome-to-the-newpipe-development-docs" > Welcome to the NewPipe Development Docs< / h1 >
2018-11-16 18:23:26 +00:00
< p > < img width = 150 src = "https://raw.githubusercontent.com/TeamNewPipe/NewPipe/dev/assets/new_pipe_icon_5.png" / > < / p >
2019-03-01 09:02:33 +00:00
< p > This site is/should be a beginner friendly tutorial and documentation for people who want to use or write services for the < a href = "https://github.com/TeamNewPipe/NewPipeExtractor" > NewPipe Extractor< / a > . However, it also contains several notes about how to maintain NewPipe.
2020-03-01 21:17:35 +00:00
It is an addition to our auto generated < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/" > Jdoc documentation< / a > .< / p >
2019-03-01 09:02:33 +00:00
< p > Please be aware that it is in its early stages, so help and < a href = "https://github.com/TeamNewPipe/documentation/issues" > feedback< / a > is always appreciated :D< / p >
2018-05-05 21:49:18 +00:00
< h2 id = "introduction" > Introduction< / h2 >
2019-03-01 09:02:33 +00:00
< p > The NewPipeExtractor is a Java framework for scraping video platform websites in a way that they can be accessed like a normal API. The extractor is the core of the popular YouTube and streaming app < a href = "https://newpipe.schabi.org" > NewPipe< / a > for Android. It is entirely independent from said platforms and also available for additional platforms as well. < / p >
< p > The beauty behind this framework is that it takes care of the extracting process, error handling etc. so you can focus on what is important: Scraping the website.
2018-12-14 08:57:47 +00:00
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 >
2018-02-20 22:51:11 +00:00
< / div >
2022-08-28 12:50:59 +00:00
< / div > < footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer Navigation" >
2019-03-01 09:02:33 +00:00
< 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 >
2018-02-22 16:11:04 +00:00
< / div >
2018-02-20 22:51:11 +00:00
< hr / >
< div role = "contentinfo" >
<!-- Copyright etc -->
< / div >
2022-08-28 12:50:59 +00:00
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 > .
2018-02-20 22:51:11 +00:00
< / footer >
2022-08-28 12:50:59 +00:00
2018-02-20 22:51:11 +00:00
< / div >
< / div >
< / section >
< / div >
2022-08-28 12:50:59 +00:00
< div class = "rst-versions" role = "note" aria-label = "Versions" >
2021-10-20 23:09:50 +00:00
< span class = "rst-current-version" data-toggle = "rst-current-version" >
< span > < a href = "00_Prepare_everything/" style = "color: #fcfcfc" > Next » < / a > < / span >
< / span >
2018-02-20 22:51:11 +00:00
< / div >
2023-08-13 18:03:19 +00:00
< script src = "js/jquery-3.6.0.min.js" > < / script >
< script > var base _url = "." ; < / script >
< script src = "js/theme_extra.js" > < / script >
< script src = "js/theme.js" > < / script >
< script src = "search/main.js" > < / script >
< script >
jQuery(function () {
2020-08-13 00:02:52 +00:00
SphinxRtdTheme.Navigation.enable(true);
2023-08-13 18:03:19 +00:00
});
2020-08-13 00:02:52 +00:00
< / script >
2018-02-20 22:51:11 +00:00
< / body >
< / html >
<!--
2023-08-13 18:03:19 +00:00
MkDocs version : 1.5.2
Build Date UTC : 2023-08-13 18:03:19.137188+00:00
2018-02-20 22:51:11 +00:00
-->
