updated dev requirements; sphinx pdf output fix

r3w0p · r3w0p · commit 3fd9ec84d4f0 · 2024-06-26T16:26:25.000+01:00
diff --git a/README.md b/README.md
@@ -28,7 +28,6 @@ https://doi.org/10.21105/joss.05858)
 https://ko-fi.com/r3w0p)
 <br/>
 
-
 `BoboCEP` is a [Complex Event Processing](https://en.wikipedia.org/wiki/Complex_event_processing) (CEP) engine
 designed for [edge computing](https://en.wikipedia.org/wiki/Edge_computing) in
 [Internet of Things](https://en.wikipedia.org/wiki/Internet_of_things) (IoT) systems
@@ -37,10 +36,16 @@ It provides [fault tolerance](https://en.wikipedia.org/wiki/Fault_tolerance) (FT
 [active replication](https://en.wikipedia.org/wiki/Replication_(computing)) of
 partially-completed complex events across multiple instances of the software.
 
-
 ## License
 
-`BoboCEP` is open source, as per the
+It is an open source project, as per the
 [Open Source Definition](https://opensource.org/osd).
-The code in this repository can be redistributed and/or modified under the terms of the 
+The [source code](https://github.com/r3w0p/bobocep)
+can be redistributed and/or modified under the terms of the 
 [MIT License](https://github.com/r3w0p/bobocep/blob/main/LICENSE).
+
+## Documentation
+
+Documentation is hosted by [Read the Docs](https://bobocep.readthedocs.io),
+which also provides a
+[PDF version](https://bobocep.readthedocs.io/_/downloads/en/latest/pdf/).
diff --git a/docs/actions.rst b/docs/actions.rst
@@ -1,6 +1,6 @@
--------
+=======
 Actions
--------
+=======
 
 On the completion of a pattern's run, the Producer is notified and
 produces a complex event in response, which represents the detection
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,8 +28,6 @@
     'sphinx.ext.coverage',
     'sphinx.ext.doctest',
     'sphinx.ext.viewcode',
-
-    'sphinx_mdinclude',
     'sphinx_rtd_theme'
 ]
 
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -1,6 +1,6 @@
-------------
+============
 Contributing
-------------
+============
 
 If you would like to contribute to the :code:`BoboCEP` project, please consult
 the `CONTRIBUTING.md <https://github.com/r3w0p/bobocep/blob/main/CONTRIBUTING.md>`_
@@ -14,8 +14,4 @@ Here are other ways through which you can contribute.
 * `Report any security vulnerabilities <https://github.com/r3w0p/bobocep/security/policy>`_
   that you become aware of.
 
-* Donate to the project via the following.
-
-.. image:: https://ko-fi.com/img/githubbutton_sm.svg
-   :alt: Ko-fi
-   :target: https://ko-fi.com/r3w0p
+* Donate to the project via `Ko-fi <https://ko-fi.com/r3w0p>`_.
diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst
@@ -1,6 +1,6 @@
----------------
+===============
 Developer Guide
----------------
+===============
 
 Dependencies
 ============
diff --git a/docs/distributed.rst b/docs/distributed.rst
@@ -1,6 +1,6 @@
------------
+===========
 Distributed
------------
+===========
 
 :code:`BoboCEP` is able to be distributed over multiple devices for
 fault-tolerant CEP at the network edge.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -1,6 +1,6 @@
---------
+========
 Examples
---------
+========
 
 Simple
 ======
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -1,6 +1,6 @@
----------------
+===============
 Getting Started
----------------
+===============
 
 Complex Event Processing
 ========================
diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -1,6 +1,6 @@
---------
+========
 Glossary
---------
+========
 
 Contiguity
 ==========
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,43 @@
-.. mdinclude:: ../README.md
+=======
+BoboCEP
+=======
+
+.. rubric:: About
+
+:code:`BoboCEP` is a
+`Complex Event Processing <https://en.wikipedia.org/wiki/Complex_event_processing>`_
+(CEP) engine designed for
+`edge computing <https://en.wikipedia.org/wiki/Edge_computing>`_
+in
+`Internet of Things <https://en.wikipedia.org/wiki/Internet_of_things>`_
+(IoT) systems to facilitate inferential reasoning and decision-making on streaming data.
+It provides
+`fault tolerance <https://en.wikipedia.org/wiki/Fault_tolerance>`_
+(FT) via the
+`active replication <https://en.wikipedia.org/wiki/Replication_(computing)>`_
+of partially-completed complex events across multiple instances of the software.
+
+.. rubric:: License
+
+It is an open source project, as per the
+`Open Source Definition <https://opensource.org/osd>`_.
+The
+`source code <https://github.com/r3w0p/bobocep>`_
+can be redistributed and/or modified under the terms of the
+`MIT License <https://github.com/r3w0p/bobocep/blob/main/LICENSE>`_.
+
+.. rubric:: Documentation
+
+Documentation is hosted by `Read the Docs <https://bobocep.readthedocs.io>`_,
+which also provides a
+`PDF version <https://bobocep.readthedocs.io/_/downloads/en/latest/pdf/>`_.
+
+
+.. toctree::
+   :caption: Contents
+   :maxdepth: 0
+   :hidden:
+
 
 .. toctree::
    :caption: Introduction
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,6 +1,6 @@
-------------
+============
 Installation
-------------
+============
 
 Dependencies
 ============
diff --git a/docs/phenomena.rst b/docs/phenomena.rst
@@ -1,6 +1,6 @@
----------
+=========
 Phenomena
----------
+=========
 
 A data stream contains uncorrelated, simple events, e.g. sensor data on a
 room's temperature at a given point in time.
diff --git a/docs/publications.rst b/docs/publications.rst
@@ -1,6 +1,6 @@
-------------
+============
 Publications
-------------
+============
 
 .. [P2023]
     Power, A. (2023).
diff --git a/docs/source_code.rst b/docs/source_code.rst
@@ -1,6 +1,6 @@
------------
+===========
 Source Code
------------
+===========
 
 Explore the :code:`BoboCEP` source code below by clicking through
 the modules.
diff --git a/docs/use_cases.rst b/docs/use_cases.rst
@@ -1,6 +1,6 @@
----------
+=========
 Use Cases
----------
+=========
 
 Assisted Living
 ===============
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,11 +1,10 @@
 bump2version==1.0.1
-coverage==7.3.1
-flake8==6.1.0
+coverage==7.5.4
+flake8==7.1.0
 Flask==2.3.3
-interrogate==1.5.0
-mypy==1.5.1
-pytest==7.4.2
+interrogate==1.7.0
+mypy==1.10.1
+pytest==8.2.2
 setuptools==70.1.1
-sphinx==5.0.0
-sphinx-mdinclude==0.5.3
-sphinx-rtd-theme==1.1.1
+sphinx==7.3.7
+sphinx-rtd-theme==2.0.0

-Original file line number
+Diff line change
@@ @@ -1,6 +1,6 @@ @@
 --------
 +=======
 Actions
 --------
 +=======
 On the completion of a pattern's run, the Producer is notified and
 produces a complex event in response, which represents the detection
Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,6 @@`
`28`	`28`	`'sphinx.ext.coverage',`
`29`	`29`	`'sphinx.ext.doctest',`
`30`	`30`	`'sphinx.ext.viewcode',`
`31`		`-`
`32`		`- 'sphinx_mdinclude',`
`33`	`31`	`'sphinx_rtd_theme'`
`34`	`32`	`]`
`35`	`33`