Updates docs and packaging stuff

.github/workflows/ci.yml

@@ -45,12 +45,12 @@ jobs:
       matrix:
         python-version: ['3.9', '3.10', '3.11']
     env:
-      TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-      TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      ENV_FORCE_PUBLISHER: ${{ secrets.FORCE_PUBLISHER }}
-      ENV_USE_PACKAGECLOUD_REPO: ${{ secrets.USE_PACKAGECLOUD_REPO }}
-      ENV_PACKAGECLOUD_OWNER: ${{ secrets.PACKAGECLOUD_OWNER }}
-      ENV_PACKAGECLOUD_DOWNLOAD_REPO: ${{ secrets.PACKAGECLOUD_DOWNLOAD_REPO }}
+      TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} >> "${GITHUB_ENV}"
+      TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} >> "${GITHUB_ENV}"
+      ENV_FORCE_PUBLISHER: ${{ secrets.FORCE_PUBLISHER }} >> "${GITHUB_ENV}"
+      ENV_USE_PACKAGECLOUD_REPO: ${{ secrets.USE_PACKAGECLOUD_REPO }} >> "${GITHUB_ENV}"
+      ENV_PACKAGECLOUD_OWNER: ${{ secrets.PACKAGECLOUD_OWNER }} >> "${GITHUB_ENV}"
+      ENV_PACKAGECLOUD_DOWNLOAD_REPO: ${{ secrets.PACKAGECLOUD_DOWNLOAD_REPO }} >> "${GITHUB_ENV}"
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}

.gitignore

@@ -120,6 +120,9 @@ ENV/
 # mypy
 .mypy_cache/
 
+# emacs backup files
+*~
+
 #
 # VIM modelines
 #

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .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.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
+
+# 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: docs/requirements.txt

Pipfile

@@ -44,6 +44,8 @@ watchdog = "*"
 [packages]
 "oslo-config" = "*"
 "oslo.messaging" = "*"
+build = "*"
+
 #
 # Local variables:
 # tab-width: 4
@@ -52,4 +54,3 @@ watchdog = "*"
 # vim600: noexpandtab sw=4 ts=4 fdm=marker
 # vim<600: noexpandtab sw=4 ts=4
 #
-build = "*"

docs/requirements.txt

@@ -0,0 +1,107 @@
+alabaster==0.7.12
+amqp==5.1.1
+argh==0.26.2
+astroid==2.13.2
+Babel==2.11.0
+bcrypt==4.0.1
+bleach==5.0.1
+build==0.10.0
+cachetools==5.2.1
+certifi==2022.12.7
+cffi==1.15.1
+charset-normalizer==3.0.1
+collective.checkdocs==0.2
+commonmark==0.9.1
+coverage==7.0.5
+cryptography==39.0.0
+debtcollector==2.5.0
+dill==0.3.6
+dnspython==2.2.1
+docutils==0.19
+eventlet==0.33.2
+fasteners==0.18
+fixtures==4.0.1
+flake8==6.0.0
+flake8-docstrings==1.6.0
+futurist==2.4.1
+greenlet==2.0.1
+idna==3.4
+imagesize==1.4.1
+importlib-metadata==6.0.0
+iso8601==1.1.0
+isort==5.11.4
+jaraco.classes==3.2.3
+Jinja2==3.1.2
+keyring==23.13.1
+kombu==5.2.4
+lazy-object-proxy==1.9.0
+MarkupSafe==2.1.1
+mccabe==0.7.0
+more-itertools==9.0.0
+msgpack==1.0.4
+mypy==0.991
+mypy-extensions==0.4.3
+netaddr==0.8.0
+netifaces==0.11.0
+oslo.concurrency==5.0.1
+oslo.config==9.1.0
+oslo.context==5.0.0
+oslo.i18n==5.1.0
+oslo.log==5.0.2
+oslo.messaging==14.1.0
+oslo.metrics==0.5.0
+oslo.middleware==5.0.0
+oslo.serialization==5.0.0
+oslo.service==3.0.0
+oslo.utils==6.1.0
+packaging==23.0
+Paste==3.5.2
+PasteDeploy==3.0.1
+pbr==5.11.1
+pep8-naming==0.13.3
+pkginfo==1.9.6
+platformdirs==2.6.2
+prometheus-client==0.15.0
+pycodestyle==2.10.0
+pycparser==2.21
+pydocstyle==6.2.3
+pyflakes==3.0.1
+Pygments==2.14.0
+pylint==2.15.10
+pyparsing==3.0.9
+pyproject_hooks==1.0.0
+python-dateutil==2.8.2
+pytz==2022.7
+PyYAML==6.0
+readme-renderer==37.3
+repoze.lru==0.7
+requests==2.28.2
+requests-toolbelt==0.10.1
+rfc3986==2.0.0
+rich==13.0.1
+Routes==2.5.1
+six==1.16.0
+snowballstemmer==2.2.0
+Sphinx==6.1.3
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+sphinxcontrib.applehelp==1.0.3
+statsd==4.0.1
+stevedore==4.1.1
+tomli==2.0.1
+tomlkit==0.11.6
+twine==4.0.2
+typed-ast==1.5.4
+typing_extensions==4.4.0
+urllib3==1.26.14
+vine==5.0.0
+watchdog==2.2.1
+webencodings==0.5.1
+WebOb==1.8.7
+wrapt==1.14.1
+xmlrunner==1.7.7
+yappi==1.4.0
+zipp==3.11.0