diff options
| author |  tsmethurst <tobi.smethurst@klarrio.com> | 2021-02-28 18:08:27 +0100 |
|---|---|---|
| committer | tsmethurst <tobi.smethurst@klarrio.com> | 2021-02-28 18:08:27 +0100 |
| commit | 294d6d174d658d1f17ec910474e89b20cdea3737 (patch) | |
| tree | 2e36a1259d37fe90f2fecb6a0b28044b1e7842b1 /docs/_build/html/pages | |
| parent | add theme to conda env (diff) | |
| download | gotosocial-294d6d174d658d1f17ec910474e89b20cdea3737.tar.xz | |
Doc updates
Diffstat (limited to 'docs/_build/html/pages')
| -rw-r--r-- | docs/_build/html/pages/design/design.html | 221 | ||||
| -rw-r--r-- | docs/_build/html/pages/design/federation.html | 219 | ||||
| -rw-r--r-- | docs/_build/html/pages/design/safety_features.html | 215 | ||||
| -rw-r--r-- | docs/_build/html/pages/user_facing/user_facing.html | 255 |
4 files changed, 910 insertions, 0 deletions
diff --git a/docs/_build/html/pages/design/design.html b/docs/_build/html/pages/design/design.html new file mode 100644 index 000000000..f70e215d1 --- /dev/null +++ b/docs/_build/html/pages/design/design.html @@ -0,0 +1,221 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>GoToSocial Design — GoToSocial documentation</title> + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script src="../../_static/jquery.js"></script> + <script src="../../_static/underscore.js"></script> + <script src="../../_static/doctools.js"></script> + + <script type="text/javascript" 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="Federation" href="federation.html" /> + <link rel="prev" title="What is GoToSocial?" href="../user_facing/user_facing.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"> GoToSocial + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <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="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../user_facing/user_facing.html">What is GoToSocial?</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">GoToSocial Design</a><ul> +<li class="toctree-l2"><a class="reference internal" href="federation.html">Federation</a></li> +<li class="toctree-l2"><a class="reference internal" href="safety_features.html">Safety Features</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">GoToSocial</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html" class="icon icon-home"></a> »</li> + + <li>GoToSocial Design</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/pages/design/design.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"> + + <div class="section" id="gotosocial-design"> +<h1>GoToSocial Design<a class="headerlink" href="#gotosocial-design" title="Permalink to this headline">¶</a></h1> +<p>These documents describe the design of GoToSocial and provide rationale for design decisions, safety features, etc.</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="federation.html">Federation</a></li> +<li class="toctree-l1"><a class="reference internal" href="safety_features.html">Safety Features</a></li> +</ul> +</div> +</div> + + + </div> + + </div> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="federation.html" class="btn btn-neutral float-right" title="Federation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="../user_facing/user_facing.html" class="btn btn-neutral float-left" title="What is GoToSocial?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2021, GoToSocial Authors. + + </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 type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/pages/design/federation.html b/docs/_build/html/pages/design/federation.html new file mode 100644 index 000000000..bba5f68d7 --- /dev/null +++ b/docs/_build/html/pages/design/federation.html @@ -0,0 +1,219 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Federation — GoToSocial documentation</title> + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script src="../../_static/jquery.js"></script> + <script src="../../_static/underscore.js"></script> + <script src="../../_static/doctools.js"></script> + + <script type="text/javascript" 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="Safety Features" href="safety_features.html" /> + <link rel="prev" title="GoToSocial Design" href="design.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"> GoToSocial + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <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="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../user_facing/user_facing.html">What is GoToSocial?</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="design.html">GoToSocial Design</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Federation</a></li> +<li class="toctree-l2"><a class="reference internal" href="safety_features.html">Safety Features</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">GoToSocial</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html" class="icon icon-home"></a> »</li> + + <li><a href="design.html">GoToSocial Design</a> »</li> + + <li>Federation</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/pages/design/federation.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"> + + <div class="section" id="federation"> +<h1>Federation<a class="headerlink" href="#federation" title="Permalink to this headline">¶</a></h1> +<p>In the spirit of Mastodon and other <a class="reference external" href="https://en.wikipedia.org/wiki/Fediverse">Fediverse</a> (“federation universe”) applications, +GoToSocial uses the <a class="reference external" href="https://www.w3.org/TR/activitypub/">ActivityPub</a> protocol to communicate between its own servers and those +of compliant software.</p> +</div> + + + </div> + + </div> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="safety_features.html" class="btn btn-neutral float-right" title="Safety Features" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="design.html" class="btn btn-neutral float-left" title="GoToSocial Design" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2021, GoToSocial Authors. + + </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 type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/pages/design/safety_features.html b/docs/_build/html/pages/design/safety_features.html new file mode 100644 index 000000000..00b8fbff1 --- /dev/null +++ b/docs/_build/html/pages/design/safety_features.html @@ -0,0 +1,215 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Safety Features — GoToSocial documentation</title> + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script src="../../_static/jquery.js"></script> + <script src="../../_static/underscore.js"></script> + <script src="../../_static/doctools.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + <link rel="index" title="Index" href="../../genindex.html" /> + <link rel="search" title="Search" href="../../search.html" /> + <link rel="prev" title="Federation" href="federation.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"> GoToSocial + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <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="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../user_facing/user_facing.html">What is GoToSocial?</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="design.html">GoToSocial Design</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="federation.html">Federation</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Safety Features</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">GoToSocial</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html" class="icon icon-home"></a> »</li> + + <li><a href="design.html">GoToSocial Design</a> »</li> + + <li>Safety Features</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/pages/design/safety_features.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"> + + <div class="section" id="safety-features"> +<h1>Safety Features<a class="headerlink" href="#safety-features" title="Permalink to this headline">¶</a></h1> +<p>Blah blah blah blah.</p> +</div> + + + </div> + + </div> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="federation.html" class="btn btn-neutral float-left" title="Federation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2021, GoToSocial Authors. + + </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 type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/pages/user_facing/user_facing.html b/docs/_build/html/pages/user_facing/user_facing.html new file mode 100644 index 000000000..2e62def88 --- /dev/null +++ b/docs/_build/html/pages/user_facing/user_facing.html @@ -0,0 +1,255 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>What is GoToSocial? — GoToSocial documentation</title> + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script src="../../_static/jquery.js"></script> + <script src="../../_static/underscore.js"></script> + <script src="../../_static/doctools.js"></script> + + <script type="text/javascript" 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="GoToSocial Design" href="../design/design.html" /> + <link rel="prev" title="Welcome to GoToSocial’s 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"> GoToSocial + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <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="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">What is GoToSocial?</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#features">Features</a></li> +<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li> +<li class="toctree-l2"><a class="reference internal" href="#open-source">Open Source</a></li> +<li class="toctree-l2"><a class="reference internal" href="#support">Support</a></li> +<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../design/design.html">GoToSocial Design</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">GoToSocial</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html" class="icon icon-home"></a> »</li> + + <li>What is GoToSocial?</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/pages/user_facing/user_facing.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"> + + <div class="section" id="what-is-gotosocial"> +<h1>What is GoToSocial?<a class="headerlink" href="#what-is-gotosocial" title="Permalink to this headline">¶</a></h1> +<p>GoToSocial will solve your problem of where to start with documentation, +by providing a basic explanation of how to do it easily.</p> +<p>Look how easy it is to use:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">project</span> +<span class="c1"># Get your stuff done</span> +<span class="n">project</span><span class="o">.</span><span class="n">do_stuff</span><span class="p">()</span> +</pre></div> +</div> +<div class="section" id="features"> +<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><p>Be awesome</p></li> +<li><p>Make things faster</p></li> +</ul> +</div> +<div class="section" id="installation"> +<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2> +<p>Install $project by running:</p> +<blockquote> +<div><p>install project</p> +</div></blockquote> +</div> +<div class="section" id="open-source"> +<h2>Open Source<a class="headerlink" href="#open-source" title="Permalink to this headline">¶</a></h2> +<p>GoToSocial is a free and open-source project.</p> +<ul class="simple"> +<li><p>Issue Tracker: <a class="reference external" href="https://github.com/gotosocial/gotosocial/issues">https://github.com/gotosocial/gotosocial/issues</a></p></li> +<li><p>Source Code: <a class="reference external" href="https://github.com/gotosocial/gotosocial">https://github.com/gotosocial/gotosocial</a></p></li> +</ul> +</div> +<div class="section" id="support"> +<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2> +<p>If you are having issues, please let us know.</p> +</div> +<div class="section" id="license"> +<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2> +<p>GoToSocial is licensed under the <a class="reference external" href="https://github.com/gotosocial/gotosocial/blob/main/LICENSE">GNU AFFERO GENERAL PUBLIC LICENSE</a> (AGPLv3).</p> +</div> +</div> + + + </div> + + </div> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="../design/design.html" class="btn btn-neutral float-right" title="GoToSocial Design" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="../../index.html" class="btn btn-neutral float-left" title="Welcome to GoToSocial’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2021, GoToSocial Authors. + + </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 type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file |