Docs

.github/workflows/wiki-docs.yaml

@@ -0,0 +1,30 @@
+name: Deploy Sphinx Docs to Wiki
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          pip install poetry
+          poetry install --with docs
+      - name: Build docs
+        run: sphinx-build -M markdown ./docs ./docs/_build
+      - name: Push to Wiki
+        run: |
+          git clone https://github.com/molecularmodelinglab/ChemGED.wiki.git
+          cp -r ./docs/_build/markdown/* ChemGED.wiki
+          cd ChemGED.wiki
+          git add .
+          git commit -m "Update documentation [auto-build]"
+          git push

.gitignore

@@ -2,3 +2,4 @@
 .venv
 tests/test-results/
 docs/_build/
+dist/

README.md

@@ -54,7 +54,7 @@ print(distances_matrix)  # Square form
 ```
 
 ## Documentation
-For more detailed documentation, please visit [ReadTheDocs](https://chemged.readthedocs.io/).
+You can read more detailed documentation in the docs folder.
 
 ## Implementation
 The approach used here uses bipartite graph matching[[1]](#1), and most of its implementation in python

docs/conf.py

@@ -33,6 +33,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
+    "sphinx_markdown_builder",
 ]
 
 templates_path = ["_templates"]

docs/requirements.txt

@@ -1,5 +1,6 @@
 sphinx>=7.1.2
 sphinx_rtd_theme>=1.3.0
+sphinx-markdown-builder>=0.6.8
 networkx>=3.5
 numpy>=2.0.0
 scipy>=1.15.3

pyproject.toml

@@ -53,6 +53,7 @@ optional = true
 [tool.poetry.group.docs.dependencies]
 sphinx = "^7.1.2"
 sphinx_rtd_theme = "^1.3.0"
+sphinx-markdown-builder = "^0.6.8"
 
 [[tool.poetry.source]]
 name = "PyPI"