Release 0.9.11

sanjacob · Sep 26, 2023 · f6f0b61 · f6f0b61
1 parent 218546d
commit f6f0b61
Show file tree

Hide file tree

Showing 8 changed files with 83 additions and 30 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 OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+   - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,9 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.9.11] - 2023-09-25
 
 ### Fixed
-- Bug introduced with the upgrade to Pydantic v2 where
-  course content with the 'groupContent' attribute
-  set would cause related content to not be downloaded
+- Bug introduced with pydantic v2 where some content would be skipped
 
 ### Changed
 - Pin dependencies in Pipfile and pyproject.toml for improved stability

diff --git a/Pipfile b/Pipfile
@@ -40,6 +40,7 @@ types-beautifulsoup4 = "*"
 types-appdirs = "*"
 types-python-dateutil = "*"
 pyqt5-stubs = "*"
+sphinx-rtd-theme = "*"
 
 [requires]
 python_version = "3.10"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/blackboard_sync/__about__.py b/blackboard_sync/__about__.py
@@ -33,7 +33,7 @@
 __summary__ = "Automatic Syncing Of Your Blackboard Content"
 __uri__ = "https://github.com/jacobszpz/BlackboardSync"
 
-__version__ = "0.9.11-alpha.2"
+__version__ = "0.9.11"
 
 __author__ = "Jacob Sánchez"
 __email__ = "jacobszpz@protonmail.com"

diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = __about__.__title__
+project = "Blackboard Sync"
 copyright = __about__.__copyright__
 author = __about__.__author__
 
@@ -70,7 +70,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-BlackboardSync
+Blackboard Sync
 ==========================================
 
 .. image:: https://img.shields.io/github/license/jacobszpz/BlackboardSync
@@ -22,39 +22,40 @@ Features
 
   - Attachments of any type (e.g. .docx, .pptx, .pdf, etc.)
   - Internet links
-  - Content descriptions (saved as markdown files [1]_)
+  - Content descriptions (saved as html)
 
 - Cross-platform
 
   - Linux, Windows, and macOS ready
 
+Installation
+------------
+
+You can find all releases on GitHub_.
+Only MacOS (.dmg) and Windows (.exe) are supported at the moment.
+
+.. _GitHub: https://github.com/jacobszpz/BlackboardSync/releases/
+
+
+From PyPI
+^^^^^^^^^
+
+.. code-block:: bash
+
+   $ python3 -m pip install blackboardsync
+   $ python3 -m blackboard_sync # notice the underscore
 
-.. [1]  List of `markdown editors`_. Personally, I like to use `Typora`_.
 
 
 API Documentation
 -----------------
 
-Information about the internal APIs.
+If you are interested about contributing, or if you just want
+to understand the internals of BlackboardSync more.
 
 .. toctree::
    :maxdepth: 2
 
    dev/bb_api
    dev/sync_api
    dev/qt_api
-
-
-Contributing
-------------
-
-If you intend to contribute to this project, this may be of interest.
-
-.. toctree::
-  :maxdepth: 2
-
-  dev/bb_api
-
-
-.. _Typora: https://typora.io
-.. _markdown editors: https://www.markdownguide.org/tools/
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,4 @@
+-i https://pypi.org/simple
+recommonmark==0.7.1
+sphinx==7.2.6; python_version >= '3.9'
+sphinx-rtd-theme==1.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'