sphinx-doc/sphinxNew scan
84/ 100 · B

Good community traction and solid fundamentals. Nearly in the top tier.

The Sphinx documentation generator

Python7,877 starsOtherupdated 2d ago
DocumentationREADME, setup, examples, license
67
EngineeringTests, CI, linting, lockfiles
97
Project healthDescription, activity, stars, deps
81

What to fix first

The highest-impact improvements for this repo.

  1. 1
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  2. 2
    README
    DocumentationInfo

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  3. 3
    README
    DocumentationInfo

    Show a quick-start snippet so contributors can see what using your project looks like.

Detailed breakdown

Documentation

67
  • README40
    • README is present.
    • README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • No status badges in the README (−10 pts).Add CI/build status badges from shields.io or your CI provider to signal project health.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Other.
  • Contributing guide50
    • CONTRIBUTING guide is very brief (0 pts for depth); 150+ words earns +6 pts, 400+ earns +12 pts.Add setup instructions, code style notes, and how to run tests.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide lacks a testing section (−8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • Contributing guide lacks a PR workflow section (−8 pts).Explain how to fork, branch, and open a pull request so contributors know what to expect.
    • Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Code of conduct present.

Engineering

97
  • Tests100
    • Test files detected (tests).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/builddoc.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting90
    • Linter or formatter configured (.prettierrc.toml).
    • Type checking configured via [tool.mypy] in pyproject.toml.
  • Reproducibility90
    • Lockfile present (package-lock.json). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • Dependabot covers 3 ecosystems (github-actions, pip, uv). Dependencies stay current.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

81
  • Dependency manifest65
    • Dependency manifest found (package.json).
    • package.json is missing a description (−10 pts).Add a one-line description to package.json. It appears in npm search and on GitHub.
    • package.json links back to the repository.
    • package.json has no keywords (−8 pts).Add a `keywords` array to help people find your package on npm.
    • package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
    • package.json has no build script (−10 pts).Add a `build` script to package.json so the project can be compiled with `npm run build`.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Python.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 7,877 stars.
  • Housekeeping100
    • .gitignore present.
Repository files30 root entries
  • .github
    Good: CI is configured (.github/workflows/builddoc.yml).
    Good: Dependabot covers 3 ecosystems (github-actions, pip, uv). Dependencies stay current.
    Good: Issue or PR templates present.
  • doc
  • sphinx
  • tests
    Good: Test files detected (tests).
  • utils
  • .codecov.yml
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .mailmap
  • .prettierrc.toml
    Good: Linter or formatter configured (.prettierrc.toml).
  • .pytest.toml
  • .readthedocs.yml
  • .ruff.toml
  • AUTHORS.rst
  • bindep.txt
  • CHANGES.rst
  • CODE_OF_CONDUCT.rst
    Good: Code of conduct present.
  • CONTRIBUTING.rst
    Info: CONTRIBUTING guide is very brief (0 pts for depth); 150+ words earns +6 pts, 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Info: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Info: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • EXAMPLES.rst
  • LICENSE.rst
    Good: Licensed under Other.
  • Makefile
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • pyproject.toml
  • pyrefly.toml
  • README.rst
    Good: README is present.
    Info: README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Warning: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Info: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Info: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tox.ini
  • ty.toml
  • uv.lock