Add furo and recommonmark dependencies

.github/workflows/documentation.yml

@@ -0,0 +1,40 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3
+
+      - name: list all files and directories in tree format
+        run: |
+          tree -a -L 2
+
+      - name: Run make init-dev
+        run: |
+            make init-dev
+      
+      - name: Make docs
+        run: |
+          make docs
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

Makefile

@@ -1,7 +1,7 @@
 TEST_PATH = ./tests/
 FLAKE8_EXCLUDE = venv,.venv,.eggs,.tox,.git,__pycache__,*.pyc
 PROJECT = pysubyt
-AUTHOR = Marc Portier 
+AUTHOR = Marc_Portier 
 
 clean:
 	@find . -name '*.pyc' -exec rm --force {} +
@@ -33,6 +33,7 @@ init-docs: startup
 docs:
 	if ! [ -d "./docs" ]; then poetry run sphinx-quickstart -q --ext-autodoc --sep --project $(PROJECT) --author $(AUTHOR) docs; fi
 	poetry run sphinx-apidoc -o ./docs/source ./$(PROJECT)
+	cp ./pre_docs/* ./docs/source/
 	poetry run sphinx-build -b html ./docs/source ./docs/build/html
 
 test:

README.md

@@ -10,9 +10,9 @@
 ### Usage and further reading
 
 Please check out the Py-SUbyt documentation. Namely:
-- the [user guide](./docs/cli.md)
-- the supported [features](./docs/features.md)
-- the [examples](./docs/examples.md)
+- the [user guide](pre_docs/cli.md)
+- the supported [features](pre_docs/features.md)
+- the [examples](pre_docs/examples.md)
 - and the [style guide](./docs/cli-style.md)!