feature: add new website

Author: Mistobaan

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: docs_pages_workflow
+
+on: [pull_request]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  build_docs_job:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.8
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          python -m pip install --upgrade pip
+          echo "dir={$(pip cache dir)}" >> $GITHUB_OUTPUT
+
+      - name: pip cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py', '**/requirements.txt', '**/docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install docs requirements
+        run: |
+          python -m pip install -r docs/requirements.txt
+
+      - name: make the sphinx docs
+        run: |
+          make -C docs clean
+          make -C docs html
+
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "trlx"
+          project-language: "en"
+          # see: https://github.com/readthedocs/actions/tree/main/preview
+          # message-template (optional): Text message to be injected by the action in the Pull Request description. It supports the following placeholders to be replaced:
+          # {docs-pr-index-url}: URL to the root of the documentation for the Pull Request preview.
+          # platform (optional): Read the Docs Community (community) or Read the Docs for Business (business). (default: community)
+          # single-version (optional): Set this to 'true' if your project is single version, so we can link to the correct URL. (default: 'false')

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change log
+
+Best viewed on [trlx.readthedocs.io](https://trlx.readthedocs.io/en/latest/changelog.html).
+
+<!--
+Remember to align the itemized text with the first line of an item within a list.
+-->
+
+## trlx 0.4.0 (2022-12-05)
+
+- python 3.8

Makefile

@@ -0,0 +1,6 @@
+gendoc:
+	docker build -t trlxgendocs -f docker/docs/Dockerfile .
+run:
+	docker run --rm -it -v ${PWD}:/build  \
+		--entrypoint /bin/bash \
+		trlxgendocs

dictionary.txt

@@ -0,0 +1 @@
+rouge

docker/docs/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.8-slim
+
+# pip install -r docs/requirements.txt
+# sphinx-build -b html docs docs/build/html -j auto
+# sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto
+
+RUN python -m pip install --upgrade --no-cache-dir pip
+ADD docs/requirements.txt /tmp/requirements.txt
+RUN python -m pip install --exists-action=w --no-cache-dir -r /tmp/requirements.txt
+RUN mkdir /build
+WORKDIR /build/docs/
+ENTRYPOINT /build/docs/build.sh
+# RUN `which sphinx-build` -T -E -b html -d _build/doctrees-readthedocs -D language=en . _build/html

docs/README.md

@@ -0,0 +1,5 @@
+# How To build the documentation
+
+```bash
+make -c docs html
+```