pytest-flakefighters 0.2.0__tar.gz

pytest_flakefighters-0.2.0/.github/workflows/ci-mega-linter.yml

@@ -0,0 +1,36 @@
+name: Linting and formatting
+
+on:
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: MegaLinter
+        id: ml
+        uses: oxsecurity/megalinter/flavors/python@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For detailed check status
+
+      - name: Archive production artifacts
+        if: ${{ success() }} || ${{ failure() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: MegaLinter reports
+          path: |
+            megalinter-reports
+            mega-linter.log

pytest_flakefighters-0.2.0/.github/workflows/ci-tests-drafts.yaml

@@ -0,0 +1,37 @@
+name: CI Tests Draft
+# This duplicate ci workflow is required so the badge in the README.md is not effected by draft PRs
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    if: github.event.pull_request.draft == true
+    name: Ex1 (${{ matrix.python-version }}, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+       python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+          python --version
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install -e .[test]
+          pip install pytest pytest-cov
+    - name: Test with pytest
+      run: |
+        pytest -p no:flakefighters --cov=src --cov-report=xml
+    - name: "Upload coverage to Codecov"
+      uses: codecov/codecov-action@v5
+      with:
+        fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}

pytest_flakefighters-0.2.0/.github/workflows/ci-tests.yaml

@@ -0,0 +1,42 @@
+name: CI Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+
+jobs:
+  build:
+    if: github.event.pull_request.draft == false # Filter out draft PRs
+    name: Ex1 (${{ matrix.python-version }}, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+          python --version
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install -e .[test]
+          pip install pytest pytest-cov
+    - name: Test with pytest
+      run: |
+        pytest -p no:flakefighters --cov=src --cov-report=xml
+    - name: "Upload coverage to Codecov"
+      uses: codecov/codecov-action@v5
+      with:
+        fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}

pytest_flakefighters-0.2.0/.github/workflows/publish-pypi.yaml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build-release:
+    name: Build and publish PyPI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install build tools
+        run: |
+          pip install --upgrade pip setuptools wheel build setuptools_scm
+
+      - name: Build Package
+        run: |
+          python -m build --no-isolation
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

pytest_flakefighters-0.2.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/build/
+docs/source/autoapi
+.ipynb_checkpoints/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+megalinter-reports/
+
+*.db
+
+# Hide autogenerated sourcecode docs
+docs/source/autoapi
+
+# Hide autogenerated version file
+_version.py

pytest_flakefighters-0.2.0/.mega-linter.yaml

@@ -0,0 +1,14 @@
+# Configuration file for MegaLinter
+# See all available variables at https://oxsecurity.github.io/megalinter/configuration/ and in linters documentation
+
+ENABLE_LINTERS:
+  - PYTHON_PYLINT
+  - PYTHON_BLACK
+
+GITHUB_STATUS_REPORTER: true
+
+FILTER_REGEX_INCLUDE: (src/|tests/)
+FILTER_REGEX_EXCLUDE: (tests/resources/)
+
+APPLY_FIXES: all
+PYTHON_PYLINT_CONFIG_FILE: pyproject.toml

pytest_flakefighters-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/PyCQA/isort
+  rev: 6.0.1 # Use the latest version
+  hooks:
+    - id: isort
+- repo: https://github.com/ambv/black
+  rev: 25.1.0
+  hooks:
+    - id: black
+      language_version: python3.11
+- repo: local
+  hooks:
+    - id: pylint
+      name: pylint
+      entry: pylint
+      language: system
+      types: [python]
+      args: ['--max-line-length=120', '--max-positional-arguments=12']
+      files: ^src/|^tests/

pytest_flakefighters-0.2.0/.readthedocs.yaml

@@ -0,0 +1,27 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/source/requirements.txt
+   - method: pip
+     path: . # This should tell RTD to install the CTF from root to render the Estimators page correctly.

pytest_flakefighters-0.2.0/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2025 TestFLARE Team
+
+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.

pytest_flakefighters-0.2.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: pytest-flakefighters
+Version: 0.2.0
+Summary: Pytest plugin implementing flaky test failure detection and classification.
+Author: TestFLARE Team
+Project-URL: Homepage, https://test-flare.github.io/
+Project-URL: Documentation, https://pytest-flakefighters.readthedocs.io
+Project-URL: Repository, https://github.com/test-flare/pytest-flakefighters
+Project-URL: Issues, https://github.com/test-flare/pytest-flakefighters/issues
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=6.2.0
+Requires-Dist: coverage>=7.10.6
+Requires-Dist: GitPython>=3.1.45
+Requires-Dist: unidiff>=0.7.5
+Requires-Dist: sqlalchemy>=2.0.43
+Requires-Dist: dotenv>=0.9.9
+Requires-Dist: pandas>=2.3
+Requires-Dist: scipy<=1.15
+Requires-Dist: pyyaml>=6
+Requires-Dist: scikit-learn>=1.7
+Requires-Dist: nltk>=3.9
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pre_commit; extra == "dev"
+Requires-Dist: sphinx-autoapi; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Requires-Dist: tox>=4.31.0; extra == "dev"
+Requires-Dist: myst_parser; extra == "dev"
+Requires-Dist: nbsphinx; extra == "dev"
+Requires-Dist: pytest-html; extra == "dev"
+Requires-Dist: pytest-json-report>=1.5; extra == "dev"
+Provides-Extra: pg
+Requires-Dist: psycopg2>2.9; extra == "pg"
+Dynamic: license-file
+
+# Pytest FlakeFighters
+### Pytest plugin implementing flaky test failure detection and classification.
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![PyPI version](https://img.shields.io/pypi/v/pytest-flakefighters.svg)](https://pypi.org/project/pytest-flakefighters)
+[![Python versions](https://img.shields.io/pypi/pyversions/pytest-flakefighters.svg)](https://pypi.org/project/pytest-flakefighters)
+![Test status](https://github.com/test-flare/pytest-flakefighters/actions/workflows/ci-tests.yaml/badge.svg)
+[![codecov](https://codecov.io/gh/test-flare/pytest-flakefighters/branch/main/graph/badge.svg?token=04ijFVrb4a)](https://codecov.io/gh/test-flare/pytest-flakefighters)
+[![Documentation Status](https://readthedocs.org/projects/causal-testing-framework/badge/?version=latest)](https://causal-testing-framework.readthedocs.io/en/latest/?badge=latest)
+![GitHub License](https://img.shields.io/github/license/test-flare/pytest-flakefighters)
+
+
+
+## Features
+
+-   Implements the [DeFlaker algorithm](https://deflaker.com/) for pytest
+
+
+## Installation
+
+You can install \"pytest-flakefighters\" by cloning this repo and running `pip install .` from the root directory.
+If you intend to develop the plugin, run `pip install -e .[dev]` instead.
+
+We eventually intend to distribute our tool on PyPI.
+
+## Usage
+
+FlakeFighter is intended to run on git repositories that have test suites runnable with `pytest`.
+Once you have installed FlakeFighter, you can run it from the root directory of your repo simply by running `pytest` in your usual way.
+FlakeFighter has the following arguments.
+
+```
+  --target-commit=TARGET_COMMIT
+                        The target (newer) commit hash. Defaults to HEAD (the most recent commit).
+  --source-commit=SOURCE_COMMIT
+                        The source (older) commit hash. Defaults to HEAD^ (the previous commit to target).
+  --repo=REPO_ROOT      The commit hash to compare against.
+  --suppress-flaky-failures-exit-code
+                        Return OK exit code if the only failures are flaky failures.
+  --no-save             Do not save this run to the database of previous flakefighters runs.
+  -M LOAD_MAX_RUNS, --load-max-runs=LOAD_MAX_RUNS
+                        The maximum number of previous runs to consider.
+  -D DATABASE_URL, --database-url=DATABASE_URL
+                        The database URL. Defaults to 'flakefighter.db' in current working directory.
+  --store-max-runs=STORE_MAX_RUNS
+                        The maximum number of previous flakefighters runs to store. Default is to store all.
+  --time-immemorial=TIME_IMMEMORIAL
+                        How long to store flakefighters runs for, specified as `days:hours:minutes`. E.g. to store
+                        tests for one week, use 7:0:0.
+```
+
+## Contributing
+
+Contributions are very welcome.
+Tests can be run with [pytest](https://pytest.readthedocs.io/en/latest/), please ensure the coverage at least stays the same before you submit a pull request.
+
+## Flake Fighters
+Our plugin is made up of a collection of heuristics that come together to help inform whether a test failure is genuine or flaky.
+These come in two "flavours": those which run live after each test, and those which run at the end of the entire test suite.
+Both extend the base class `FlakeFighter` and implement the `flaky_failure` method, which returns `True` if the test is deemed to be flaky.
+
+## Issues
+
+If you encounter any problems, please [file an issue](https://github.com/test-flare/pytest-flakefighters/issues) along with a detailed description.
+
+------------------------------------------------------------------------
+
+This [pytest](https://github.com/pytest-dev/pytest) plugin was generated with [Cookiecutter](https://github.com/audreyr/cookiecutter) along with [\@hackebrot](https://github.com/hackebrot)\'s [cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin) template.

pytest_flakefighters-0.2.0/README.md

@@ -0,0 +1,68 @@
+# Pytest FlakeFighters
+### Pytest plugin implementing flaky test failure detection and classification.
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![PyPI version](https://img.shields.io/pypi/v/pytest-flakefighters.svg)](https://pypi.org/project/pytest-flakefighters)
+[![Python versions](https://img.shields.io/pypi/pyversions/pytest-flakefighters.svg)](https://pypi.org/project/pytest-flakefighters)
+![Test status](https://github.com/test-flare/pytest-flakefighters/actions/workflows/ci-tests.yaml/badge.svg)
+[![codecov](https://codecov.io/gh/test-flare/pytest-flakefighters/branch/main/graph/badge.svg?token=04ijFVrb4a)](https://codecov.io/gh/test-flare/pytest-flakefighters)
+[![Documentation Status](https://readthedocs.org/projects/causal-testing-framework/badge/?version=latest)](https://causal-testing-framework.readthedocs.io/en/latest/?badge=latest)
+![GitHub License](https://img.shields.io/github/license/test-flare/pytest-flakefighters)
+
+
+
+## Features
+
+-   Implements the [DeFlaker algorithm](https://deflaker.com/) for pytest
+
+
+## Installation
+
+You can install \"pytest-flakefighters\" by cloning this repo and running `pip install .` from the root directory.
+If you intend to develop the plugin, run `pip install -e .[dev]` instead.
+
+We eventually intend to distribute our tool on PyPI.
+
+## Usage
+
+FlakeFighter is intended to run on git repositories that have test suites runnable with `pytest`.
+Once you have installed FlakeFighter, you can run it from the root directory of your repo simply by running `pytest` in your usual way.
+FlakeFighter has the following arguments.
+
+```
+  --target-commit=TARGET_COMMIT
+                        The target (newer) commit hash. Defaults to HEAD (the most recent commit).
+  --source-commit=SOURCE_COMMIT
+                        The source (older) commit hash. Defaults to HEAD^ (the previous commit to target).
+  --repo=REPO_ROOT      The commit hash to compare against.
+  --suppress-flaky-failures-exit-code
+                        Return OK exit code if the only failures are flaky failures.
+  --no-save             Do not save this run to the database of previous flakefighters runs.
+  -M LOAD_MAX_RUNS, --load-max-runs=LOAD_MAX_RUNS
+                        The maximum number of previous runs to consider.
+  -D DATABASE_URL, --database-url=DATABASE_URL
+                        The database URL. Defaults to 'flakefighter.db' in current working directory.
+  --store-max-runs=STORE_MAX_RUNS
+                        The maximum number of previous flakefighters runs to store. Default is to store all.
+  --time-immemorial=TIME_IMMEMORIAL
+                        How long to store flakefighters runs for, specified as `days:hours:minutes`. E.g. to store
+                        tests for one week, use 7:0:0.
+```
+
+## Contributing
+
+Contributions are very welcome.
+Tests can be run with [pytest](https://pytest.readthedocs.io/en/latest/), please ensure the coverage at least stays the same before you submit a pull request.
+
+## Flake Fighters
+Our plugin is made up of a collection of heuristics that come together to help inform whether a test failure is genuine or flaky.
+These come in two "flavours": those which run live after each test, and those which run at the end of the entire test suite.
+Both extend the base class `FlakeFighter` and implement the `flaky_failure` method, which returns `True` if the test is deemed to be flaky.
+
+## Issues
+
+If you encounter any problems, please [file an issue](https://github.com/test-flare/pytest-flakefighters/issues) along with a detailed description.
+
+------------------------------------------------------------------------
+
+This [pytest](https://github.com/pytest-dev/pytest) plugin was generated with [Cookiecutter](https://github.com/audreyr/cookiecutter) along with [\@hackebrot](https://github.com/hackebrot)\'s [cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin) template.

pytest_flakefighters-0.2.0/codecov.yml

@@ -0,0 +1,20 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "reach,diff,flags,files,footer"
+  behavior: default
+  require_changes: no

pytest_flakefighters-0.2.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)