Skip to content

Commit

Permalink
added homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
777arc committed Nov 29, 2024
1 parent ed193c2 commit 8c36eb1
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 12 deletions.
49 changes: 49 additions & 0 deletions _templates/homepage.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<h1 style="text-align: center">PySDR: A Guide to SDR and DSP using Python</h1>

<p style="text-align: center">
by
<a class="reference internal" href="content/about_author.html#author-chapter">
<span class="std std-ref">Dr. Marc Lichtman</span>
</a>
-
<a
class="reference external"
href="mailto:pysdr&#37;&#52;&#48;vt&#46;edu"
rel="noopener noreferrer"
target="_blank"
>
pysdr<span>&#64;</span>vt<span>&#46;</span>edu
</a>
</p>

<h4 style="line-height: 1.4">
Welcome to PySDR, a free online textbook (not a Python library!) that provides a gentle introduction
to wireless communications and software-defined radio (SDR) using an abundance
of diagrams, animations, and Python code examples. From FFTs to filters to
digital modulation to receiving and transmitting from SDRs in Python, PySDR
has you covered!
</h4>

<h4 style="line-height: 1.4">
The goal of PySDR is to increase accessibility to topics traditionally covered
in a math-intensive manner and within a relatively small set of universities.
All content used to generate PySDR is open source, and can be found
<a
class="reference external"
href="https://github.com/777arc/PySDR"
rel="noopener noreferrer"
target="_blank"
>here</a
>.
</h4>

<h4>
See
<a class="reference internal" href="content/intro.html#intro-chapter"
><span class="std std-ref">Chapter 1: Introduction</span></a
>
for the textbook's purpose and target audience.
</h4>
<br />

DEMO
10 changes: 10 additions & 0 deletions _templates/layout.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
{%- extends "basic/layout.html" %}

<!-- this block modifies the html titles to use a pipe and edits the title of the root page -->
{%- set customtitlesuffix = " | "|safe + docstitle|e %}
{%- block htmltitle %}
{% if "no title" in title %}
<title>{{ docstitle }}</title>
{% else %}
<title>{{ title|striptags|e }}{{ customtitlesuffix }}</title>
{% endif %}
{%- endblock %}

{% block extrahead %}

{{ super() }}
Expand Down
15 changes: 3 additions & 12 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
==========================================
PySDR: A Guide to SDR and DSP using Python
==========================================

by :ref:`Dr. Marc Lichtman<author-chapter>` - [email protected]

Welcome to PySDR, a free online textbook that provides a gentle introduction to wireless communications and software-defined radio (SDR) using an abundance of diagrams, animations, and Python code examples. The primary goal of PySDR is to increase accessibility to topics traditionally covered at the graduate level within a relatively small set of universities. All content of PySDR is open source, even the code used to generate the figures/animations, and can be found `here <https://github.com/777arc/PySDR>`_.

See Chapter 1: :ref:`intro-chapter` for the textbook's purpose and target audience.
.. raw:: html
:file: _templates/homepage.html

.. raw:: html

<details>
<summary><h3 style="display: inline;">Expand for full table of contents</h3></summary>
<summary><h4 style="display: inline;">Expand for full table of contents</h4></summary>

.. toctree::
:maxdepth: 3
Expand Down Expand Up @@ -44,5 +37,3 @@ See Chapter 1: :ref:`intro-chapter` for the textbook's purpose and target audien
.. raw:: html

</details>

Home page will go here

0 comments on commit 8c36eb1

Please sign in to comment.