autoredocs 0.3.0__tar.gz

autoredocs-0.3.0/.env.example

@@ -0,0 +1,37 @@
+# =============================================================================
+# Autoredocs Environment Configuration
+# =============================================================================
+# Copy this file to .env and fill in your values:
+#   cp .env.example .env
+#
+# NEVER commit .env to version control. It is already in .gitignore.
+# =============================================================================
+
+# --- AI (Groq) ---------------------------------------------------------------
+# Required for: autoredocs ai-fill, autoredocs generate --ai
+# Get your key at: https://console.groq.com/keys
+GROQ_API_KEY=
+
+# --- Netlify ------------------------------------------------------------------
+# Required for: autoredocs deploy --target netlify
+# Get your token at: https://app.netlify.com/user/applications#personal-access-tokens
+NETLIFY_TOKEN=
+NETLIFY_SITE_ID=
+
+# --- Vercel -------------------------------------------------------------------
+# Required for: autoredocs deploy --target vercel
+# Get your token at: https://vercel.com/account/tokens
+VERCEL_TOKEN=
+VERCEL_PROJECT_ID=
+
+# --- AWS S3 -------------------------------------------------------------------
+# Required for: autoredocs deploy --target s3
+# Create credentials at: https://console.aws.amazon.com/iam
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=us-east-1
+S3_BUCKET=
+
+# --- GitHub Webhook -----------------------------------------------------------
+# Required for: autoredocs serve --webhook-secret, serverless handlers
+GITHUB_WEBHOOK_SECRET=

autoredocs-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install ruff
+        run: pip install ruff
+      - name: Run ruff check
+        run: ruff check src/ tests/
+      - name: Run ruff format check
+        run: ruff format --check src/ tests/
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package
+        run: pip install -e ".[dev]"
+      - name: Run tests
+        run: pytest tests/ -v --tb=short --cov=autoredocs --cov-report=term-missing
+      - name: Upload coverage
+        if: matrix.python-version == '3.12' && matrix.os == 'ubuntu-latest'
+        uses: codecov/codecov-action@v4
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install build tools
+        run: pip install build
+      - name: Build wheel
+        run: python -m build
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

autoredocs-0.3.0/.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  PYTHON_VERSION: "3.12"
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install autoredocs
+        run: pip install -e ".[ai,server]"
+
+      - name: Generate documentation
+        run: |
+          autoredocs generate \
+            --source ./src \
+            --output ./docs \
+            --format html \
+            --incremental \
+            --ai
+        env:
+          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
+
+      - name: Deploy to Netlify
+        if: env.NETLIFY_TOKEN != ''
+        run: autoredocs deploy --output ./docs --target netlify
+        env:
+          NETLIFY_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+
+      - name: Upload build report
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-report
+          path: docs/build_report.json
+
+      - name: Upload docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/

autoredocs-0.3.0/.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: "3.12"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install autoredocs
+        run: pip install -e ".[ai,dev]"
+
+      - name: Generate AI-enhanced documentation
+        run: autoredocs generate --source src/autoredocs --output _site --format html --ai --incremental
+        env:
+          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

autoredocs-0.3.0/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.mypy_cache/
+
+# Autoredocs
+.autoredocs_state.json
+docs/
+test_output/
+
+# Environment
+.env
+.env.local
+.env.*.local

autoredocs-0.3.0/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to autoredocs
+
+Thank you for considering contributing to autoredocs.
+
+## Development Setup
+
+```bash
+git clone https://github.com/ShivamBwaj/autoredocs.git
+cd autoredocs
+pip install -e ".[dev]"
+```
+
+## Running Tests
+
+```bash
+pytest tests/ -v
+```
+
+All 78 tests must pass before submitting a pull request.
+
+## Code Style
+
+This project uses [Ruff](https://github.com/astral-sh/ruff) for linting:
+
+```bash
+pip install ruff
+ruff check src/ tests/
+```
+
+Target: Python 3.10+, line length 100.
+
+## Pull Request Guidelines
+
+1. Fork the repository and create your branch from `main`.
+2. Add tests for any new functionality.
+3. Ensure all tests pass.
+4. Run the linter with zero warnings.
+5. Write clear commit messages.
+
+## Adding a New Language Parser
+
+1. Create a new parser class in `src/autoredocs/parsers/` that extends `BaseParser`.
+2. Implement the `parse_file` method.
+3. Set the `extensions` class attribute to the file extensions it handles.
+4. The parser registry in `src/autoredocs/parsers/__init__.py` will auto-discover it.
+5. Add tests in `tests/`.
+
+## Adding a New Deploy Target
+
+1. Create a new class in `src/autoredocs/deploy.py` that extends `BaseDeployer`.
+2. Implement the `deploy(docs_dir: Path) -> str` method.
+3. Add it to the `DEPLOYERS` registry dict.
+4. Document the required environment variables in `README.md` and `.env.example`.
+
+## Reporting Issues
+
+Open an issue on GitHub with:
+
+- Python version (`python --version`)
+- Operating system
+- Steps to reproduce
+- Expected vs actual behavior

autoredocs-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Autoredocs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.