Issue#54

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: Deploy API Docs to GitHub Pages
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Copia README.md para docs/
+        run: tail -n +2 README.md >> docs/readme.md
+
+      - name: Disable Jekyll
+        run: touch docs/.nojekyll
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install Python dependencies
+        run: pip install -r requirements.txt
+
+      - name: Export OpenAPI schema
+        env:
+          SECRET_KEY: dummy
+          ALGORITHM: HS256
+          ACCESS_TOKEN_EXPIRE_MINUTES: 20
+          SQLITE_PATH: /tmp/pynewsdb.db
+          SQLITE_URL: sqlite+aiosqlite:////tmp/pynewsdb.db
+          PYTHONPATH: .
+        run: python scripts/export_openapi.py app.main:app docs/openapi.json
+
+      - name: Build Sphinx docs (com Redoc embutido)
+        run: sphinx-build -b html docs/ docs/_build/html
+
+      - name: Upload built site to Pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build-docs
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/api.md

@@ -0,0 +1,7 @@
+# API
+
+Abaixo está a especificação OpenAPI do PyNewsServer:
+
+```{redoc}
+../openapi.json
+```

docs/conf.py

@@ -0,0 +1,45 @@
+# -- Project information -----------------------------------------------------
+project = "pynewsserver"
+author = "PyNews"
+
+# -- General configuration ---------------------------------------------------
+extensions = [
+    "myst_parser",
+    "sphinx_rtd_theme",
+    "sphinxcontrib.redoc",
+    "sphinx_copybutton",
+]
+
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+    "linkify",
+    "substitution",
+]
+
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+
+master_doc = "index"
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+html_theme = "sphinx_rtd_theme"
+html_title = "Documentação - PyNewsServer"
+html_static_path = ['_static']
+
+# -- Options for sphinxcontrib-redoc -----------------------------------------
+redoc = [
+    {
+        "name": "OpenAPI",
+        "page": "api",
+        "spec": "../openapi.json",
+        "embed": True,
+        "opts": {
+            "hide-hostname": True
+        }
+    },
+]

docs/index.md

@@ -0,0 +1,9 @@
+# Documentação do PyNewsServer
+
+```{toctree}
+:maxdepth: 2
+:caption: Sumário
+
+readme
+api
+```

docs/readme.md

@@ -0,0 +1,2 @@
+# Documentação do PyNewsServer
+<!-- Este arquivo será sobrescrito automaticamente pelo workflow do GitHub Actions. -->