Merge pull request #2 from BojanSof/docs-update-multiversion

Docs update multiversion

.github/workflows/documentation.yml

@@ -23,7 +23,7 @@ jobs:
           pip install -r requirements/doc.txt
       - name: Sphinx build
         run: |
-          sphinx-build docs _build
+          sphinx-multiversion docs _build
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

README.rst

@@ -0,0 +1,53 @@
+.. image:: https://raw.githubusercontent.com/BojanSof/PyDevDTK/main/images/icon.png
+    :align: center
+    :width: 256
+
+PyDevDTK
+========
+
+Python package that provides basic tools for device development, including:
+
+Communication protocols:
+
+    - UART
+    - BLE
+
+Real-time visualizations, which can be fully customized, or use one of the following plots:
+
+    - Line plots
+    - Scatter plots
+    - Bar plots
+    - Image plots
+
+More communication protocols and plots are added iteratively.
+
+Installing
+----------
+
+The repository includes GitHub actions which publish the package to PyPI and TestPyPI. To install the latest release package, run:
+
+.. code-block:: shell
+
+    pip install pydevdtk
+
+To install the latest development package, which is published on TestPyPI, run:
+
+.. code-block:: shell
+
+    pip install --index-url https://test.pypi.org/simple pydevdtk
+
+If you need to install the package locally for development, run the following command in the root of the repository:
+
+.. code-block:: shell
+
+    pip install -e .
+
+Requirements
+------------
+
+Requirements can be found under ``requirements`` directory, which includes:
+
+- ``default.txt`` - base requirements for the package
+- ``build.txt`` - requirements for building the package
+- ``doc.txt`` - requirements for building the documentation (WIP)
+- ``dev.txt`` - requirements for developing the package, including linters and formatters

docs/_templates/versions.html

@@ -0,0 +1,27 @@
+{%- if current_version %}
+<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+  <span class="rst-current-version" data-toggle="rst-current-version">
+    <span class="fa fa-book"> Other Versions</span>
+    v: {{ current_version.name }}
+    <span class="fa fa-caret-down"></span>
+  </span>
+  <div class="rst-other-versions">
+    {%- if versions.tags %}
+    <dl>
+      <dt>Tags</dt>
+      {%- for item in versions.tags %}
+      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+      {%- endfor %}
+    </dl>
+    {%- endif %}
+    {%- if versions.branches %}
+    <dl>
+      <dt>Branches</dt>
+      {%- for item in versions.branches %}
+      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+      {%- endfor %}
+    </dl>
+    {%- endif %}
+  </div>
+</div>
+{%- endif %}

docs/coms.rst

@@ -0,0 +1,26 @@
+Communication Protocols
+=======================
+
+This section of the documentation covers the communication protocols used 
+by the PyDevDTK. It includes details on serial and Bluetooth Low Energy 
+(BLE) communication modules.
+
+Serial Communication
+--------------------
+
+The serial communication module provides facilities for serial port 
+communication.
+
+.. automodule:: pydevdtk.coms.serial
+   :members:
+   :undoc-members:
+
+Bluetooth Low Energy (BLE) Communication
+----------------------------------------
+
+The BLE communication module facilitates communication over Bluetooth Low 
+Energy.
+
+.. automodule:: pydevdtk.coms.ble
+   :members:
+   :undoc-members:

docs/conf.py

@@ -14,7 +14,6 @@
 project = "PyDevDTK"
 copyright = "2024, Bojan Sofronievski"
 author = "Bojan Sofronievski"
-release = "0.1.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -25,6 +24,8 @@
     "sphinx.ext.duration",
     "sphinx.ext.viewcode",
     "sphinx.ext.githubpages",
+    "sphinx_multiversion",
+    "sphinx.ext.napoleon",
     "myst_parser",
 ]