Add Documentation (#1)

* start with some docs * Started sphinx docs * update to docs * document breaking change more * Dumb emoji * test RTD configuration * Docs now build successfully. Not finished yet, but marked sections as TODO * Update RTD settings * lint * Some clean up * Update .readthedocs.yaml * add more links to setup.py * and black * py.typed * bump version to 0.3.0 * fix changelog Co-authored-by: Matteo Pompili <[email protected]>
matpompili · Aug 1, 2022 · ca4ec66 · ca4ec66
1 parent b973cbb
commit ca4ec66
Show file tree

Hide file tree

Showing 25 changed files with 682 additions and 65 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+   os: ubuntu-22.04
+   tools:
+     python: "3.10"
+     # You can also specify other tool versions:
+     # nodejs: "16"
+     # rust: "1.55"
+     # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements-dev.txt
+   - method: pip
+     path: .
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,18 @@
 # Changelog
 
-## [v0.2.2](https://github.com/matpompili/easypubsub/tree/v0.2.2) (Ureleased)
+## [v0.3.0](https://github.com/matpompili/easypubsub/tree/v0.3.0) (Unreleased)
 
-[Full Changelog](https://github.com/matpompili/easypubsub/compare/v0.2.1...main)
+- Added documentation to the :obj:`~easypubsub.proxy.Proxy`, :obj:`~easypubsub.subscriber.Subscriber`, and :obj:`~easypubsub.publisher.Publisher` classes.
+- Setup Sphinx documentation and Readthedocs.
+- Breaking change: :obj:`~easypubsub.proxy.Proxy` now expects first the address for the publishers and then the address for the subscribers, to make it easier to remember (pub-sub). Fixed tests and examples accordingly.
 
-## [v0.2.1](https://github.com/matpompili/easypubsub/tree/v0.2.1) (2022-07-29)
+[Full v0.3.0 Changelog](https://github.com/matpompili/easypubsub/compare/v0.2.1...v0.3.0)
 
-[Full Changelog](https://github.com/matpompili/easypubsub/compare/v0.2.0...v0.2.1)
+## [v0.2.1](https://github.com/matpompili/easypubsub/tree/v0.2.1) (2022-07-29)
 
 - Fixed a bug for Proxy, where it would not quit using CTRL-C on Windows.
 - Added `CHANGELOG.md` to the repository.
 - `Proxy` now runs in a separate thread, so it is non-blocking.
-- Created a few simple tests.
+- Created a few simple tests.
+
+[Full v0.2.1 Changelog](https://github.com/matpompili/easypubsub/compare/v0.2.0...v0.2.1)
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,7 @@
 include README.md
 include LICENSE
 include requirements.txt
+include requirements-dev.txt
+include easypubsub/py.typed
 
 recursive-include tests *
diff --git a/Pipfile b/Pipfile
@@ -12,6 +12,9 @@ black = "~=22.6"
 isort = "~=5.10"
 build = "~=0.8"
 pytest = "~=7.1"
+Sphinx = "~=5.1"
+sphinx-rtd-theme = "~=1.0"
+m2r2 = "~=0.3"
 
 [requires]
 python_version = "3.8"
diff --git a/Pipfile.lock b/Pipfile.lock