wip

Author: JoshKarpel

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+<!--- Provide a general summary of your changes here. -->
+
+Tasks
+-----
+
+- [ ] Updated changelog.
+- [ ] Updated documentation.

.github/workflows/publish-docs.yml

@@ -0,0 +1,23 @@
+name: publish-docs_old
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v3.3.0
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v4.5.0
+      with:
+        python-version: "3.x"
+    - name: Install Poetry
+      uses: snok/install-poetry@v1.3.3
+    - name: Install Package
+      run: poetry install
+    - name: Build and deploy docs_old
+      run:  poetry run mkdocs gh-deploy --clean --strict --verbose --force

.github/workflows/quality-check.yml

@@ -41,8 +41,8 @@ jobs:
 #        run: poetry run mypy
       - name: Test code
         run: poetry run pytest -v --cov --cov-report=xml --durations=20
-#      - name: Test docs
-#        run: poetry run mkdocs build --clean --strict --verbose
+      - name: Test docs_old
+        run: poetry run mkdocs build --clean --strict --verbose
       - name: Upload coverage
         uses: codecov/codecov-action@v3.1.1
         with:

.gitignore

@@ -63,9 +63,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-#docs/_build/
-
 # PyBuilder
 target/
 

.pre-commit-config.yaml

@@ -26,7 +26,7 @@ repos:
       - id: python-use-type-annotations
       - id: python-check-blanket-type-ignore
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.21.0
+    rev: 0.22.0
     hooks:
       - id: check-github-workflows
       - id: check-github-actions
@@ -44,3 +44,7 @@ repos:
     rev: 23.1.0
     hooks:
       - id: black
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.13.0
+    hooks:
+      - id: blacken-docs

.readthedocs.yml

@@ -4,7 +4,7 @@ build:
   image: latest
 
 sphinx:
-  configuration: docs/source/conf.py
+  configuration: docs_old/source/conf.py
 
 formats: all
 
@@ -14,4 +14,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - docs_old

docs/Makefile

@@ -0,0 +1,7 @@
+# API Reference
+
+::: idesolver.IDESolver
+
+::: idesolver.global_error
+
+::: idesolver.complex_quad

docs/api.md

@@ -0,0 +1,16 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
+
+document$.subscribe(() => {
+  MathJax.typesetPromise()
+})