{"id":50723669,"url":"https://github.com/uthcode/sphinxcontrib-coderun","last_synced_at":"2026-06-10T02:03:49.645Z","repository":{"id":360242693,"uuid":"1248835013","full_name":"uthcode/sphinxcontrib-coderun","owner":"uthcode","description":"sphinxcontrib-coderun","archived":false,"fork":false,"pushed_at":"2026-05-25T15:10:29.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-25T17:11:24.415Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uthcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-25T05:09:13.000Z","updated_at":"2026-05-25T15:10:32.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/uthcode/sphinxcontrib-coderun","commit_stats":null,"previous_names":["uthcode/sphinxcontrib-coderun"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/uthcode/sphinxcontrib-coderun","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uthcode%2Fsphinxcontrib-coderun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uthcode%2Fsphinxcontrib-coderun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uthcode%2Fsphinxcontrib-coderun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uthcode%2Fsphinxcontrib-coderun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uthcode","download_url":"https://codeload.github.com/uthcode/sphinxcontrib-coderun/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uthcode%2Fsphinxcontrib-coderun/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34133406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-10T02:03:48.878Z","updated_at":"2026-06-10T02:03:49.636Z","avatar_url":"https://github.com/uthcode.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinxcontrib-coderun\n\nA Sphinx extension that adds an interactive **Run** button to code files in your\ndocumentation. Powered by a self-hosted [codeapi](https://github.com/nalgeon/codapi)\ninstance — you bring your own server, this extension wires it into Sphinx.\n\n## How it works\n\n1. You self-host a [codeapi](https://github.com/nalgeon/codapi) server (supports C,\n   Python, Go, Rust, and [many more](https://github.com/nalgeon/sandboxes)).\n2. You add `.. coderun::` directives to your `.rst` files.\n3. When a reader clicks **Run**, the code is sent to your codeapi server, executed in\n   an isolated sandbox, and the output appears inline on the page.\n\nNothing is shared with third-party services — all execution happens on your own\ninfrastructure.\n\n## Install\n\n```sh\npip install sphinxcontrib-coderun\n```\n\n## Configuration\n\nIn your `conf.py`:\n\n```python\nextensions = [..., \"sphinxcontrib.coderun\"]\n\n# URL of your self-hosted codeapi instance\ncoderun_url = \"https://codapi.example.com\"\n\n# Default sandbox (matches a sandbox configured on your codeapi server)\ncoderun_sandbox = \"gcc\"\n```\n\nBoth settings can be overridden per-directive (see below).\n\n## Usage\n\nReplace `.. literalinclude::` with `.. coderun::` wherever you want a Run button:\n\n```rst\n.. coderun:: cprogs/hello.c\n   :language: c\n```\n\nOverride the sandbox or URL for a specific snippet:\n\n```rst\n.. coderun:: examples/hello.py\n   :language: python\n   :sandbox: python\n   :url: https://codapi.example.com\n```\n\nAll standard `literalinclude` options work — `:lines:`, `:linenos:`,\n`:emphasize-lines:`, etc.\n\n## Self-hosting codeapi\n\nYou need a running codeapi instance that the browser can reach. Quickstart:\n\n```sh\n# Pull the server and a sandbox image\ndocker pull nalgeon/codapi\ndocker pull codapi/gcc   # or python, go, etc.\n\n# Run the server\ndocker run -p 1313:1313 -v /path/to/config:/opt/codapi nalgeon/codapi\n```\n\nFor production deployment (Kubernetes, TLS, rate limiting) see the\n[codeapi documentation](https://github.com/nalgeon/codapi/tree/main/docs).\n\nPoint `coderun_url` at the public URL of your server and you're done.\n\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futhcode%2Fsphinxcontrib-coderun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Futhcode%2Fsphinxcontrib-coderun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futhcode%2Fsphinxcontrib-coderun/lists"}