{"id":21330891,"url":"https://github.com/eliemichel/sphinx_literate","last_synced_at":"2026-03-09T23:35:53.776Z","repository":{"id":151778938,"uuid":"614244819","full_name":"eliemichel/sphinx_literate","owner":"eliemichel","description":"An advanced literate programming tool for writing incremental programming courses.","archived":false,"fork":false,"pushed_at":"2025-06-29T08:45:31.000Z","size":353,"stargazers_count":6,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-12T09:38:59.366Z","etag":null,"topics":["documentation","literate-programming","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://eliemichel.github.io/sphinx_literate/doc","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eliemichel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"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},"funding":{"github":null,"patreon":"eliemichel","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=DNEEF8GDX2EV6\u0026currency_code=EUR\u0026source=url"]}},"created_at":"2023-03-15T07:38:32.000Z","updated_at":"2025-06-29T08:45:34.000Z","dependencies_parsed_at":"2025-06-29T09:26:10.439Z","dependency_job_id":"913750b9-f638-44d6-8564-7d3b75bd7de8","html_url":"https://github.com/eliemichel/sphinx_literate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eliemichel/sphinx_literate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eliemichel%2Fsphinx_literate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eliemichel%2Fsphinx_literate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eliemichel%2Fsphinx_literate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eliemichel%2Fsphinx_literate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eliemichel","download_url":"https://codeload.github.com/eliemichel/sphinx_literate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eliemichel%2Fsphinx_literate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30316772,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T20:05:46.299Z","status":"ssl_error","status_checked_at":"2026-03-09T19:57:04.425Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","literate-programming","sphinx-extension"],"created_at":"2024-11-21T22:25:38.482Z","updated_at":"2026-03-09T23:35:53.759Z","avatar_url":"https://github.com/eliemichel.png","language":"Python","funding_links":["https://patreon.com/eliemichel","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=DNEEF8GDX2EV6\u0026currency_code=EUR\u0026source=url"],"categories":[],"sub_categories":[],"readme":"Sphinx Literate\n===============\n\nThis is a sphinx extension inspired by *literate programming* that I develop for the redaction of the [LearnWebGPU C++ guide](https://eliemichel.github.io/LearnWebGPU).\n\nBasically, the idea of *literate programming* is that instead of first writing a code with docstring comments and then extract a documentation out of it, we first write the documentation and specify how to connect the different code snippets together so that we can extract the source tree from the documentation (what is called \"tangling\").\n\n**Important:** At this early stage, the project focuses on providing what I need for myself rather than properly documenting, because I focus on the redaction of the WebGPU guide, but feel free to reach out to get more info about the undocumented bits.\n\nBuilding\n--------\n\nBuilding the website requires Python.\n\n1. It is recommended, but not mandatory, to set up a virtual Python environment:\n\n```\n$ virtualenv venv\n$ venv/Scripts/activate\n```\n\n2. Then install Python packages\n\n```\npip install -r requirements.txt\n```\n\n3. Build the html documentation by running:\n\n```\nmake html\n```\n\n4. And extract the source code from doc (what is call \"tangling\") by running:\n\n```\nmake tangle\n```\n\nBasic usage\n-----------\n\nAs I was saying, no time to fully document now, but you can still check out [`doc/introduction.md`](doc/introduction.md) for some details.\n\n![Screenshot of the documentation](doc/images/screenshot.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feliemichel%2Fsphinx_literate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feliemichel%2Fsphinx_literate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feliemichel%2Fsphinx_literate/lists"}