Update the readthedocs config

.gitignore

@@ -1,87 +1,27 @@
+# Based on https://github.com/github/gitignore/blob/main/Python.gitignore
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
-*$py.class
-
-# C extensions
-*.so
 
 # Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
 dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
+MANIFEST
 *.egg-info/
-.installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
+*.venv/
 
 # Unit test / coverage reports
-htmlcov/
 .tox/
-.coverage
-.coverage.*
-.cache
 nosetests.xml
-coverage.xml
-*,cover
-.hypothesis/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
+.pytest_cache/
 
 # Sphinx documentation
 docs/_build/
 
-# PyBuilder
-target/
-
-# IPython Notebook
-.ipynb_checkpoints
-
-# celery beat schedule file
-celerybeat-schedule
-
-# dotenv
-.env
-
-# virtualenv
-.venv/
-venv/
-ENV/
+# pyenv
+# .python-version
 
-# Spyder project settings
-.spyderproject
+# mypy
+.mypy_cache/
 
-# Rope project settings
-.ropeproject
+*.pickle

.readthedocs.yml

@@ -1,9 +1,21 @@
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
 version: 2
 
+# https://docs.readthedocs.io/en/stable/config-file/v2.html#build
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+# https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# https://docs.readthedocs.io/en/stable/config-file/v2.html#python
 python:
-  version: "3.8"
   install:
-    - requirements: requirements.txt
-    - method: setuptools
+    - requirements: docs/requirements.txt
+    - method: pip
       path: .
-  system_packages: true

Makefile

@@ -0,0 +1,22 @@
+test:
+	poetry run tox
+
+install:
+	poetry install
+
+update:
+	poetry lock
+	poetry install
+
+build:
+	poetry build
+
+publish:
+	poetry build
+	poetry publish
+
+docs:
+	poetry run tox -e docs
+	xdg-open docs/_build/index.html
+
+.PHONY: test install update build publish docs

docs/conf.py

@@ -15,7 +15,7 @@
 master_doc = "index"
 
 project = "phrydy"
-copyright = "2016, Josef Friedrich"
+copyright = "2016-2023, Josef Friedrich"
 author = "Josef Friedrich"
 version = phrydy.__version__
 release = phrydy.__version__

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx==5.3.0
+sphinx_rtd_theme==1.1.1