Merge branch 'feature/rtd-updates' into feature/buff-worms

 Closes #403 [ENG-8427]

Author: felliott

docs/conf.py

@@ -46,7 +46,7 @@
 
 # General information about the project.
 project = 'mfr'
-copyright = '2023, Center For Open Science'
+copyright = '2025, Center For Open Science'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -184,4 +184,3 @@
 if not on_rtd:
  import sphinx_rtd_theme
  html_theme = 'sphinx_rtd_theme'
- html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

docs/extensions.rst

@@ -11,11 +11,6 @@ CodePygmentsRenderer
 
 .. autoclass:: mfr.extensions.codepygments.CodePygmentsRenderer
 
-DocxRenderer
-------------
-
-.. autoclass:: mfr.extensions.docx.DocxRenderer
-
 ImageExporter
 -------------
 

docs/install.rst

@@ -14,26 +14,25 @@ Or download one of the following:
 * tarball_
 * zipball_
 
-Make sure that you have installed `pspp <https://www.gnu.org/software/pspp/>`_ and are using python 3.5 or greater.
+Make sure that you have installed `pspp <https://www.gnu.org/software/pspp/>`_ and are using python v3.13 or greater.
 
-Install the versions of ``setuptools`` and ``invoke`` found in the requirements.txt file:
+Install ``poetry`` to manage dependencies:
 
 .. code-block:: bash
 
- pip install setuptools==37.0.0
- pip install invoke==0.13.0
+ pip install poetry==2.1.2
 
 Install requirements:
 
 .. code-block:: bash
 
- invoke install
+ poetry install
 
 Or for some nicities (like tests):
 
 .. code-block:: bash
 
- invoke install --develop
+ poetry install --with dev
 
 Start the server:
 
@@ -45,7 +44,7 @@ Start the server:
 
 .. code-block:: bash
 
- invoke server
+ poetry run invoke server
 
 .. _Github: https://github.com/CenterForOpenScience/modular-file-renderer
 .. _tarball: https://github.com/CenterForOpenScience/modular-file-renderer/tarball/master

readthedocs.yml

@@ -1,3 +1,18 @@
-requirements_file: doc-requirements.txt
-python:
- setup_py_install: true
+version: 2
+
+build:
+ os: ubuntu-24.04
+ tools:
+ python: "3.13"
+ jobs:
+ post_create_environment:
+ - pip install poetry
+ post_install:
+ - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
+
+sphinx:
+ configuration: docs/conf.py
+
+formats:
+ - pdf
+ - epub