Merge branch 'main' into patch-2

.github/workflows/deploy-github-pages.yml

@@ -0,0 +1,41 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+  workflow_dispatch: # This line allows manual triggering
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+            python-version: '3.7'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt && pip install -r docs/requirements.txt
+      - name: Build website
+        run: cd docs && make html
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./docs/build/html
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/python-package.yml

@@ -5,6 +5,8 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+
+  workflow_dispatch: # This line allows manual triggering
 
 jobs:
   build:

.github/workflows/python-publish.yml

@@ -0,0 +1,45 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+  workflow_dispatch: # This line allows manual triggering
+
+  #push:
+  #  branches:
+  #    - master
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.9'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.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 OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+    install:
+#    - requirements: requirements.txt
+    - requirements: docs/requirements.txt

README.md

@@ -1,4 +1,8 @@
-[![Build Status](https://travis-ci.org/whoosh-community/whoosh.svg?branch=master)](https://travis-ci.org/whoosh-community/whoosh)
+[![Build Status](https://travis-ci.org/Sygil-Dev/whoosh-reloaded.svg?branch=master)](https://travis-ci.org/Sygil-Dev/whoosh-reloaded)
+
+This repository (whoosh-reloaded) is a fork and continuation of the Whoosh project. The original Whoosh project is no longer maintained. This fork is maintained by the Sygil-Dev Organization.
+
+--------------------------------------
 
 About Whoosh
 ============
@@ -51,18 +55,24 @@ or ``pip`` to download and install Whoosh automatically::
     # Install the development version from Github.
     $ pip install git+https://github.com/Sygil-Dev/whoosh.git
 
+Getting the source.
+==================
+
+You can check out the latest version of the source code on GitHub using git:
+
+    $ git clone https://github.com/Sygil-Dev/whoosh.git
+
 Learning more
 =============
 
-* Read the online documentation at https://docs.red-dove.com/whoosh/ (Search DOES work).
+* Online Documentation:
+
+  *   [Github Pages](https://sygil-dev.github.io/whoosh-reloaded/)
+
+  *   [Read the Docs](https://whoosh-reloaded.readthedocs.io/en/latest/) 
+
+* Read the old online documentation at https://docs.red-dove.com/whoosh/ (Search work properly).
 
 * Read the old online documentation at https://whoosh.readthedocs.org/en/latest/ (Search DOES NOT work).
 
 * File bug reports and issues at https://github.com/Sygil-Dev/whoosh/issues
-
-Getting the source.
-==================
-
-You can check out the latest version of the source code on GitHub using git:
-
-    $ git clone https://github.com/Sygil-Dev/whoosh.git

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx_rtd_theme
+sphinx-jsonschema