fix: read the docs build error

Kohulan · Jan 17, 2024 · af8a779 · af8a779
1 parent 36dad79
commit af8a779
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,6 +7,11 @@ repos:
     -   id: check-yaml
     -   id: debug-statements
     -   id: requirements-txt-fixer
+-   repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.1
+    hooks:
+    -   id: docformatter
+        args: [--in-place]
 -   repo: https://github.com/psf/black
     rev: 22.6.0
     hooks:

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -4,13 +4,19 @@
 # Required
 version: 2
 
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
 # Optionally build your docs in additional formats such as PDF
 formats:
-  - pdf
+  - epub
 
 # Optionally set the version of Python and requirements required to build your docs
 python:

diff --git a/docs/index.rst b/docs/index.rst
@@ -22,7 +22,7 @@ Install DECIMER in the command line using pip:
 
 .. code-block::
 
-   $ pip install decimer
+   pip install decimer
 
 .. toctree::
    :maxdepth: 2