First Commit

.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+FROM python:3.9.18-bullseye
+WORKDIR /app
+COPY . .
+RUN apt-get update && apt-get install -y texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra latexmk texlive-lang-greek texlive-luatex texlive-xetex texlive-fonts-extra dvipng librsvg2-bin git fonts-roboto
+RUN pip install -r docs/requirements.txt

.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+{
+	"name": "Dockerfile",
+	"build": {
+		"context": "..",
+		"dockerfile": "Dockerfile"
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"lextudio.restructuredtext",
+				"lextudio.restructuredtext-pack",
+				"trond-snekvik.simple-rst",
+				"ms-python.python"
+			]
+		}
+	}
+}

.github/workflows/artifact-management.yaml

@@ -0,0 +1,17 @@
+name: "Artifact Management"
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '15 8 1 * *'
+
+jobs:
+  delete-artifacts:
+    runs-on: ubuntu-latest
+    steps:
+      - uses:  dscabsa/purge-artifacts-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          expire-in: 7days
+
+

.github/workflows/link-check.yaml

@@ -0,0 +1,36 @@
+name: "Link Check"
+
+on: 
+  workflow_dispatch:
+  schedule:
+    - cron: '0 */12 * * *'
+
+jobs:
+  link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v3
+
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: 'pip'
+
+      - name: Python Install Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: link-check
+        run: make -C docs/ linkcheck SPHINXOPTS="-W --keep-going -n -q"
+
+      - name: Arhive Log
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v2
+        env:
+          PR_NUMBER: ${{ github.event.number }}
+          ID:  ${{ github.run_attempt }}
+        with:
+          name: LINKCHECK-${{ env.PR_NUMBER }}-${{ env.ID }}
+          path: docs/build/linkcheck/output.txt
+          retention-days: 7

.github/workflows/pull-request.yaml

@@ -0,0 +1,130 @@
+name: "Pull Request Docs Check"
+
+on: 
+- pull_request
+
+jobs:           
+  build-pdf:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v3
+
+      - name: Refresh Packages
+        run: sudo apt-fast -y update
+
+      - name: Install Dependencies
+        run: xargs -a dependencies sudo apt-fast install -y
+
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: 'pip'
+
+      - name: Python Install Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build PDF
+        env:
+          SPHINXOPTS: "-D html_context.commit=${{ github.sha }} -D version=latest -A display_github=true -A github_user=${{ github.repository_owner }} -A github_repo=${{ github.event.repository.name }} -A github_version=${{ github.ref_name }} -A conf_py_path=/docs/source/"
+        run: make -C docs/ latexpdf
+
+      - name: Archive PDF
+        env:
+          PR_NUMBER: ${{ github.event.number }}
+          ID:  ${{ github.run_attempt }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: FTCDOCS-PDF
+          path: |
+            docs/build/latex/*.pdf
+            FTCDOCS-PR-${{ env.PR_NUMBER }}-${{ env.ID }} 
+          if-no-files-found: error
+
+  build-html:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v3
+
+      - name: Refresh Packages
+        run: sudo apt-fast -y update
+
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: 'pip'
+
+      - name: Python Install Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build Site
+        env:
+          SPHINXOPTS: "-D html_context.commit=${{ github.sha }} -D version=latest -A display_github=true -A github_user=${{ github.repository_owner }} -A github_repo=${{ github.event.repository.name }} -A github_version=${{ github.ref_name }} -A conf_py_path=/docs/source/"
+        run: make -C docs/ html
+
+      - name: Archive Site
+        uses: actions/upload-artifact@v3
+        with:
+          name: FTCDOCS-HTML
+          path: 'docs/build/html'
+          if-no-files-found: error
+
+  spelling-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v3
+
+      - uses: reviewdog/action-misspell@v1
+        with:
+          locale: "US"
+          reporter: "github-check"
+
+  link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v3
+
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: 'pip'
+
+      - name: Python Install Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: link-check
+        run: make -C docs/ linkcheck SPHINXOPTS="-W --keep-going -n -q"
+
+      - name: Archive Log
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v2
+        env:
+          PR_NUMBER: ${{ github.event.number }}
+          ID:  ${{ github.run_attempt }}
+        with:
+          name: LINKCHECK
+          path: docs/build/linkcheck/output.txt
+          retention-days: 7
+
+  image-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v3
+
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Python Install Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: image-check
+        run: make -C docs/ imagecheck

.gitignore

@@ -0,0 +1,169 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks
+
+### JupyterNotebooks ###
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+
+### VIM
+*.swp
+*.swo
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
+
+# PyCharm project settings
+.idea/
+.idea/workspace.xml
+.idea/ftcdocs.iml
+.idea/misc.xml
+.idea/misc.xml
+.idea/workspace.xml
+.idea/ftcdocs.iml