[CIVIS-9747] MAINT migrate docs to readthedocs; support Python 3.13 (#11

)

.circleci/config.yml

@@ -11,7 +11,7 @@ jobs:
         type: string
     docker:
       # Pick the highest Python 3.x version that this package is known to support
-      - image: cimg/python:3.12
+      - image: cimg/python:3.13
     steps:
       - checkout
       - run:
@@ -96,7 +96,7 @@ workflows:
             - bandit
           matrix:
             parameters:
-              python-version: ["3.10", "3.11", "3.12"]
+              python-version: ["3.10", "3.11", "3.12", "3.13"]
       - build-python-win:
           requires:
             - flake8

.gitignore

@@ -6,3 +6,4 @@
 .python-version
 .venv
 **/async_graph_data_flow.egg-info
+docs/build/

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+
+# Declare the full Python requirements required for stability.
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+    # Install the `async-graph-data-flow` package from the local directory.
+    - method: pip
+      path: .

CHANGELOG.md

@@ -19,6 +19,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Security
 
+## [1.5.0] - 2024-10-30
+
+### Added
+- Python 3.13 is officially supported and tested on CI. (#11)
+
+### Changed
+- Migrated the docs to the Read The Docs site. (#11)
+
 ## [1.4.0] - 2023-11-30
 
 ### Added

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2022-2023, Civis Analytics
+Copyright (c) 2022-2024, Civis Analytics
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

MANIFEST.in

@@ -0,0 +1 @@
+include CHANGELOG.md

README.md

@@ -6,7 +6,7 @@
 
 ## Full Documentation
 
-Please visit https://civisanalytics.github.io/async-graph-data-flow
+Please visit https://async-graph-data-flow.readthedocs.io
 
 Please also check out this
 [blog post](https://www.civisanalytics.com/blog/open-source-software-release-introducing-async-graph-data-flow-a-python-library-for-efficient-data-pipelines/)
@@ -36,17 +36,18 @@ flake8 src tests examples
 black --check src tests examples
 ```
 
-## For Maintainers
+## Building Documentation
 
-To update the Sphinx documentation,
-the source files that need editing are under `docs/source/`;
-everything else under `docs/` is auto-generated.
-After the manual updates under `docs/source/` are ready,
-the HTML pages are updated as follows:
+We use the Sphinx framework. The documentation source files are in `docs/source/`.
+These files can be updated as necessary.
 
-```bash
-rm -r docs/_sources docs/_static && rm docs/*.html
+The public documentation is accessible at https://async-graph-data-flow.readthedocs.io.
+The doc build is configured by `.readthedocs.yaml`. 
+Normally, even when we need to update the documentation or make a new release of async-graph-data-flow,
+neither this configuration YAML file nor Civis's account on the Read the Docs site need any updates.
+The builds by the Read The Docs site generate the necessary files (the HTML pages and other things)
+for the public documentation. All these auto-generated files are explicitly not versioned (see `.gitignore`).
 
-# Run the following command *twice* -- certain HTML updates only show up after multiple `sphinx-build` runs.
-sphinx-build docs/source docs
-```
+To build the documentation locally (for testing and development),
+install the full doc-related dependencies: `pip install -r docs/requirements.txt`,
+then run `sphinx-build -b html docs/ docs/build/`.