-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: commit b71dc13 made on 2023-08-12T22:07:13+00:00 from refs/head…
…s/main by bigcat88
- Loading branch information
0 parents
commit 3a03c66
Showing
118 changed files
with
17,512 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: b189085f32a601f3f2145dc0d3b107b0 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
<!DOCTYPE html> | ||
<html class="writer-html5" lang="en" > | ||
<head> | ||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> | ||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
<title>Installation — NcPyApi 0.0.29.dev0 documentation</title> | ||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> | ||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" /> | ||
<link rel="stylesheet" href="_static/tabs.css" type="text/css" /> | ||
<link rel="stylesheet" href="_static/css/styles.css" type="text/css" /> | ||
<link rel="stylesheet" href="_static/css/dark.css" type="text/css" /> | ||
<link rel="stylesheet" href="_static/css/light.css" type="text/css" /> | ||
<!--[if lt IE 9]> | ||
<script src="_static/js/html5shiv.min.js"></script> | ||
<![endif]--> | ||
|
||
<script src="_static/jquery.js"></script> | ||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> | ||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> | ||
<script src="_static/doctools.js"></script> | ||
<script src="_static/sphinx_highlight.js"></script> | ||
<script src="_static/clipboard.min.js"></script> | ||
<script src="_static/copybutton.js"></script> | ||
<script src="_static/tabs.js"></script> | ||
<script src="_static/js/script.js"></script> | ||
<script src="_static/js/theme.js"></script> | ||
<link rel="index" title="Index" href="genindex.html" /> | ||
<link rel="search" title="Search" href="search.html" /> | ||
<link rel="next" title="First steps" href="FirstSteps.html" /> | ||
<link rel="prev" title="NC_Py_API documentation" href="index.html" /> | ||
</head> | ||
|
||
<body class="wy-body-for-nav"> | ||
<div class="wy-grid-for-nav"> | ||
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
<div class="wy-side-scroll"> | ||
<div class="wy-side-nav-search" > | ||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> | ||
NcPyApi | ||
<img src="_static/logo.svg" class="logo" alt="Logo"/> | ||
</a> | ||
<div class="version"> | ||
0.0.29.dev0 | ||
</div> | ||
<div role="search"> | ||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | ||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> | ||
<input type="hidden" name="check_keywords" value="yes" /> | ||
<input type="hidden" name="area" value="default" /> | ||
</form> | ||
</div> | ||
</div><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="current reference internal" href="#">Installation</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="FirstSteps.html">First steps</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="Options.html">Options</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="benchmarks/AppEcosystem.html">AppEcosystem Benchmarks</a></li> | ||
</ul> | ||
|
||
</div> | ||
</div> | ||
</nav> | ||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > | ||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
<a href="index.html">NcPyApi</a> | ||
</nav> | ||
|
||
<div class="wy-nav-content"> | ||
<div class="rst-content"> | ||
<div role="navigation" aria-label="Page navigation"> | ||
<ul class="wy-breadcrumbs"> | ||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> | ||
<li class="breadcrumb-item active">Installation</li> | ||
<li class="wy-breadcrumbs-aside"> | ||
<a href="_sources/Installation.rst.txt" rel="nofollow"> View page source</a> | ||
</li> | ||
</ul> | ||
<hr/> | ||
</div> | ||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
<div itemprop="articleBody"> | ||
|
||
<section id="installation"> | ||
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h1> | ||
<p>First it is always a good idea to update <code class="docutils literal notranslate"><span class="pre">pip</span></code> to the latest version with <strong class="command">pip</strong>:</p> | ||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">pip</span> | ||
</pre></div> | ||
</div> | ||
<p>To use it as a simple Nextcloud client install it without any additional dependencies with <strong class="command">pip</strong>:</p> | ||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">nc_py_api</span> | ||
</pre></div> | ||
</div> | ||
<p>To use in the Nextcloud Application mode install it with additional <code class="docutils literal notranslate"><span class="pre">app</span></code> dependencies with <strong class="command">pip</strong>:</p> | ||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="s2">"nc_py_api[app]"</span> | ||
</pre></div> | ||
</div> | ||
<p>To join the development of <strong>nc_py_api</strong> api install development dependencies with <strong class="command">pip</strong>:</p> | ||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="s2">"nc_py_api[dev]"</span> | ||
</pre></div> | ||
</div> | ||
<p>Congratulations, the next chapter <a class="reference internal" href="FirstSteps.html#first-steps"><span class="std std-ref">First steps</span></a> awaits.</p> | ||
<div class="admonition note"> | ||
<p class="admonition-title">Note</p> | ||
<p>If you have any installation or building questions, you can ask them in the discussions or create a issue | ||
and we will do our best to help you.</p> | ||
</div> | ||
</section> | ||
|
||
|
||
</div> | ||
</div> | ||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | ||
<a href="index.html" class="btn btn-neutral float-left" title="NC_Py_API documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
<a href="FirstSteps.html" class="btn btn-neutral float-right" title="First steps" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||
</div> | ||
|
||
<hr/> | ||
|
||
<div role="contentinfo"> | ||
<p>© Copyright 2023 Nextcloud GmbH.</p> | ||
</div> | ||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</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>. | ||
|
||
|
||
</footer> | ||
</div> | ||
</div> | ||
</section> | ||
</div> | ||
<script> | ||
jQuery(function () { | ||
SphinxRtdTheme.Navigation.enable(true); | ||
}); | ||
</script> | ||
|
||
</body> | ||
</html> |
Oops, something went wrong.