William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-25 07:00:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added EPUB output to documentation build

Browse Source
This commit is contained in:
Mark Qvist 2023-02-23 17:25:38 +01:00
parent b381a61be8
commit 3b1936ef48
25 changed files with 54 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -47,7 +47,7 @@ documentation:
make -C docs html make -C docs html
manual: manual:
make -C docs latexpdf make -C docs latexpdf epub
release: test remove_symlinks build_wheel build_pure_wheel documentation manual create_symlinks release: test remove_symlinks build_wheel build_pure_wheel documentation manual create_symlinks

5
docs/Makefile
View File

@ -30,3 +30,8 @@ help:
cp -r build/latex/reticulumnetworkstack.pdf ./Reticulum\ Manual.pdf; \ cp -r build/latex/reticulumnetworkstack.pdf ./Reticulum\ Manual.pdf; \
echo "PDF Manual Generated"; \ echo "PDF Manual Generated"; \
fi fi
@if [ $@ = "epub" ]; then \
cp -r build/epub/ReticulumNetworkStack.epub ./Reticulum\ Manual.epub; \
echo "EPUB Manual Generated"; \
fi

BIN
docs/Reticulum Manual.epub Normal file
View File

Binary file not shown.

BIN
docs/Reticulum Manual.pdf
View File

Binary file not shown.

2
docs/manual/.buildinfo
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9738e36d7743271d1e6118c152b32349 config: f6ba2c305fffe594c412b86b0152889d
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7

7
docs/manual/_sources/gettingstartedfast.rst.txt
View File

@ -42,6 +42,13 @@ transceivers or infrastructure just to try it out. Launching the programs on sep
devices connected to the same WiFi network is enough to get started, and physical devices connected to the same WiFi network is enough to get started, and physical
radio interfaces can then be added later. radio interfaces can then be added later.
Remote Shell
^^^^^^^^^^^^
The `rnsh <https://github.com/acehoss/rnsh>`_ program lets you establish fully interactive
remote shell sessions over Reticulum. It also allows you to pipe any program to or from a
remote system, and is similar to how ``ssh`` works.
Nomad Network Nomad Network
^^^^^^^^^^^^^ ^^^^^^^^^^^^^

4
docs/manual/_sources/index.rst.txt
View File

@ -5,6 +5,10 @@ This manual aims to provide you with all the information you need to
understand Reticulum, build networks or develop programs using it, or understand Reticulum, build networks or develop programs using it, or
to participate in the development of Reticulum itself. to participate in the development of Reticulum itself.
.. only:: html
This manual is also available in `PDF <https://github.com/markqvist/Reticulum/releases/latest/download/Reticulum.Manual.pdf>`_ and `EPUB <https://github.com/markqvist/Reticulum/releases/latest/download/Reticulum.Manual.epub>`_ formats.
.. only:: html .. only:: html
Table Of Contents Table Of Contents

2
docs/manual/examples.html
View File

@ -2543,7 +2543,7 @@ interface to efficiently pass files of any size over a Reticulum <a class="refer
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/forhumans.html
View File

@ -236,7 +236,7 @@
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/genindex.html
View File

@ -628,7 +628,7 @@
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

9
docs/manual/gettingstartedfast.html
View File

@ -253,6 +253,12 @@ links, such as local WiFi, wired Ethernet, the Internet, or any combination.</p>
transceivers or infrastructure just to try it out. Launching the programs on separate transceivers or infrastructure just to try it out. Launching the programs on separate
devices connected to the same WiFi network is enough to get started, and physical devices connected to the same WiFi network is enough to get started, and physical
radio interfaces can then be added later.</p> radio interfaces can then be added later.</p>
<section id="remote-shell">
<h3>Remote Shell<a class="headerlink" href="#remote-shell" title="Permalink to this heading">#</a></h3>
<p>The <a class="reference external" href="https://github.com/acehoss/rnsh">rnsh</a> program lets you establish fully interactive
remote shell sessions over Reticulum. It also allows you to pipe any program to or from a
remote system, and is similar to how <code class="docutils literal notranslate"><span class="pre">ssh</span></code> works.</p>
</section>
<section id="nomad-network"> <section id="nomad-network">
<h3>Nomad Network<a class="headerlink" href="#nomad-network" title="Permalink to this heading">#</a></h3> <h3>Nomad Network<a class="headerlink" href="#nomad-network" title="Permalink to this heading">#</a></h3>
<p>The terminal-based program <a class="reference external" href="https://github.com/markqvist/nomadnet">Nomad Network</a> <p>The terminal-based program <a class="reference external" href="https://github.com/markqvist/nomadnet">Nomad Network</a>
@ -604,7 +610,7 @@ section of this manual.</p>
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>
@ -634,6 +640,7 @@ section of this manual.</p>
<li><a class="reference internal" href="#">Getting Started Fast</a><ul> <li><a class="reference internal" href="#">Getting Started Fast</a><ul>
<li><a class="reference internal" href="#standalone-reticulum-installation">Standalone Reticulum Installation</a></li> <li><a class="reference internal" href="#standalone-reticulum-installation">Standalone Reticulum Installation</a></li>
<li><a class="reference internal" href="#try-using-a-reticulum-based-program">Try Using a Reticulum-based Program</a><ul> <li><a class="reference internal" href="#try-using-a-reticulum-based-program">Try Using a Reticulum-based Program</a><ul>
<li><a class="reference internal" href="#remote-shell">Remote Shell</a></li>
<li><a class="reference internal" href="#nomad-network">Nomad Network</a></li> <li><a class="reference internal" href="#nomad-network">Nomad Network</a></li>
<li><a class="reference internal" href="#sideband">Sideband</a></li> <li><a class="reference internal" href="#sideband">Sideband</a></li>
</ul> </ul>

2
docs/manual/hardware.html
View File

@ -442,7 +442,7 @@ connectivity for client devices.</p>
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

4
docs/manual/index.html
View File

@ -226,6 +226,7 @@
<p>This manual aims to provide you with all the information you need to <p>This manual aims to provide you with all the information you need to
understand Reticulum, build networks or develop programs using it, or understand Reticulum, build networks or develop programs using it, or
to participate in the development of Reticulum itself.</p> to participate in the development of Reticulum itself.</p>
<p>This manual is also available in <a class="reference external" href="https://github.com/markqvist/Reticulum/releases/latest/download/Reticulum.Manual.pdf">PDF</a> and <a class="reference external" href="https://github.com/markqvist/Reticulum/releases/latest/download/Reticulum.Manual.epub">EPUB</a> formats.</p>
<section id="table-of-contents"> <section id="table-of-contents">
<h2>Table Of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading">#</a></h2> <h2>Table Of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading">#</a></h2>
</section> </section>
@ -242,6 +243,7 @@ to participate in the development of Reticulum itself.</p>
<li class="toctree-l1"><a class="reference internal" href="gettingstartedfast.html">Getting Started Fast</a><ul> <li class="toctree-l1"><a class="reference internal" href="gettingstartedfast.html">Getting Started Fast</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gettingstartedfast.html#standalone-reticulum-installation">Standalone Reticulum Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="gettingstartedfast.html#standalone-reticulum-installation">Standalone Reticulum Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="gettingstartedfast.html#try-using-a-reticulum-based-program">Try Using a Reticulum-based Program</a><ul> <li class="toctree-l2"><a class="reference internal" href="gettingstartedfast.html#try-using-a-reticulum-based-program">Try Using a Reticulum-based Program</a><ul>
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#remote-shell">Remote Shell</a></li>
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#nomad-network">Nomad Network</a></li> <li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#nomad-network">Nomad Network</a></li>
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#sideband">Sideband</a></li> <li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#sideband">Sideband</a></li>
</ul> </ul>
@ -408,7 +410,7 @@ to participate in the development of Reticulum itself.</p>
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/interfaces.html
View File

@ -954,7 +954,7 @@ that a large span of network types can seamlessly <em>co-exist</em> and intercon
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/networks.html
View File

@ -421,7 +421,7 @@ connected outliers are now an integral part of the network.</p>
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/reference.html
View File

@ -1494,7 +1494,7 @@ will announce it.</p>
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/search.html
View File

@ -241,7 +241,7 @@
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
docs/manual/support.html
View File

@ -288,7 +288,7 @@ report issues, suggest functionality and contribute code to Reticulum.</p>
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/understanding.html
View File

@ -1126,7 +1126,7 @@ those risks are acceptable to you.</p>
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/using.html
View File

@ -757,7 +757,7 @@ WantedBy=multi-user.target
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/manual/whatis.html
View File

@ -390,7 +390,7 @@ want to help out with this, or can help sponsor an audit, please do get in touch
<div class="bottom-of-page"> <div class="bottom-of-page">
<div class="left-details"> <div class="left-details">
<div class="copyright"> <div class="copyright">
Copyright &#169; 2022, Mark Qvist Copyright &#169; 2023, Mark Qvist
</div> </div>
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://github.com/pradyunsg/furo">Furo</a> <a href="https://github.com/pradyunsg/furo">Furo</a>

2
docs/source/conf.py
View File

@ -10,7 +10,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'Reticulum Network Stack' project = 'Reticulum Network Stack'
copyright = '2022, Mark Qvist' copyright = '2023, Mark Qvist'
author = 'Mark Qvist' author = 'Mark Qvist'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags

7
docs/source/gettingstartedfast.rst
View File

@ -42,6 +42,13 @@ transceivers or infrastructure just to try it out. Launching the programs on sep
devices connected to the same WiFi network is enough to get started, and physical devices connected to the same WiFi network is enough to get started, and physical
radio interfaces can then be added later. radio interfaces can then be added later.
Remote Shell
^^^^^^^^^^^^
The `rnsh <https://github.com/acehoss/rnsh>`_ program lets you establish fully interactive
remote shell sessions over Reticulum. It also allows you to pipe any program to or from a
remote system, and is similar to how ``ssh`` works.
Nomad Network Nomad Network
^^^^^^^^^^^^^ ^^^^^^^^^^^^^

4
docs/source/index.rst
View File

@ -5,6 +5,10 @@ This manual aims to provide you with all the information you need to
understand Reticulum, build networks or develop programs using it, or understand Reticulum, build networks or develop programs using it, or
to participate in the development of Reticulum itself. to participate in the development of Reticulum itself.
.. only:: html
This manual is also available in `PDF <https://github.com/markqvist/Reticulum/releases/latest/download/Reticulum.Manual.pdf>`_ and `EPUB <https://github.com/markqvist/Reticulum/releases/latest/download/Reticulum.Manual.epub>`_ formats.
.. only:: html .. only:: html
Table Of Contents Table Of Contents