Fix readthedocs

.readthedocs.yaml

@@ -2,10 +2,16 @@
 version: 2
 
 sphinx:
-   configuration: generated-docs/out/conf.py
+  configuration: generated-docs/out/conf.py
 
-# Optionally set the version of Python and requirements required to build your docs
 python:
-   version: 3.7
-   install:
-   - requirements: generated-docs/out/requirements.pip
+  install:
+  - requirements: generated-docs/out/requirements.txt
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+    nodejs: "18" # not sure if needed but better to fix its version
+    rust: "1.64" # not sure if needed but better to fix its version
+    golang: "1.19" # not sure if needed but better to fix its version

README.md

@@ -6,8 +6,8 @@
 
 
 [![Gitter](https://badges.gitter.im/softwaremill/diffx.svg)](https://gitter.im/softwaremill/diffx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/softwaremill/diffx&style=flat)](https://mergify.io)
 [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-brightgreen.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
+[![Documentation Status](https://readthedocs.org/projects/diffx-scala/badge/?version=latest)](https://diffx-scala.readthedocs.io/en/latest/?badge=latest)
 
 ## Documentation
 

docs-sources/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# sttp documentation build configuration file, created by
+# diffx documentation build configuration file, created by
 # sphinx-quickstart on Thu Oct 12 15:51:09 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -42,7 +42,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ['myst_parser', 'sphinx_rtd_theme']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -54,8 +54,10 @@
 from recommonmark.parser import CommonMarkParser
 from recommonmark.transform import AutoStructify
 
-source_parsers = {
-    '.md': CommonMarkParser,
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
 }
 
 source_suffix = ['.rst', '.md']

docs-sources/flake.nix

@@ -0,0 +1,54 @@
+{
+  description = "Python shell flake";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+
+    mach-nix.url = "github:davhau/mach-nix";
+  };
+
+  outputs = { self, nixpkgs, mach-nix, flake-utils, ... }:
+    let
+      pythonVersion = "python37";
+    in
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+        mach = mach-nix.lib.${system};
+
+        pythonEnv = mach.mkPython {
+          python = pythonVersion;
+          requirements = builtins.readFile ./requirements.txt;
+        };
+        watchDocs =
+          let
+            name = "watchDocs";
+            src = pkgs.writeShellScript name ''
+              sphinx-autobuild . _build/html
+            '';
+          in
+          pkgs.stdenv.mkDerivation
+            {
+              inherit name src;
+
+              phases = [ "installPhase" "patchPhase" ];
+
+              installPhase = ''
+                mkdir -p $out/bin
+                cp $src $out/bin/${name}
+                chmod +x $out/bin/${name}
+              '';
+            };
+      in
+      {
+        devShells.default = pkgs.mkShellNoCC {
+          packages = [ pythonEnv watchDocs ];
+
+          shellHook = ''
+            export PYTHONPATH="${pythonEnv}/bin/python"
+          '';
+        };
+      }
+    );
+}

docs-sources/requirements.txt

@@ -0,0 +1,5 @@
+sphinx_rtd_theme==1.0.0
+recommonmark==0.7.1
+sphinx==4.2.0
+sphinx-autobuild==2021.3.14
+myst-parser==0.15.2

generated-docs/out/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# sttp documentation build configuration file, created by
+# diffx documentation build configuration file, created by
 # sphinx-quickstart on Thu Oct 12 15:51:09 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -42,7 +42,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ['myst_parser', 'sphinx_rtd_theme']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -54,8 +54,10 @@
 from recommonmark.parser import CommonMarkParser
 from recommonmark.transform import AutoStructify
 
-source_parsers = {
-    '.md': CommonMarkParser,
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
 }
 
 source_suffix = ['.rst', '.md']