{"id":18324042,"url":"https://github.com/dirk/doc_server","last_synced_at":"2025-04-09T15:13:56.144Z","repository":{"id":66482784,"uuid":"52693970","full_name":"dirk/doc_server","owner":"dirk","description":null,"archived":false,"fork":false,"pushed_at":"2016-03-11T04:14:42.000Z","size":35,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T15:13:53.835Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dirk.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":"support/Dockerfile","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-27T23:26:21.000Z","updated_at":"2016-02-27T23:26:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"fe2940c6-6269-4d85-9e1f-77aed4f0056d","html_url":"https://github.com/dirk/doc_server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dirk%2Fdoc_server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dirk%2Fdoc_server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dirk%2Fdoc_server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dirk%2Fdoc_server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dirk","download_url":"https://codeload.github.com/dirk/doc_server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248055275,"owners_count":21040157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-11-05T18:31:19.429Z","updated_at":"2025-04-09T15:13:56.125Z","avatar_url":"https://github.com/dirk.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doc_server\n\n**Note**: This is a work-in-progress attempt at building a Rust documentation server capable of downloading crates, compiling those crates' documentation in a background thread, and serving crates' documentation to users.\n\n### How it works\n\nThis is designed to have a user experience similar to [RubyDoc.info](http://www.rubydoc.info/): providing a copy of the generated documentation for the requested name-and-version of a public Ruby gem/Rust crate.\n\nGenerated documentation is stored on the local file-system (eg. `docs/foo-1.2.3`), if the requested documentation is not available the server starts a background thread that does the following:\n\n1. Downloads a `.crate` from the crates.io Amazon S3 archive.\n2. Expands the crate archive (it's really just a tarball).\n3. Starts an isolated Docker container in that expanded archive (using the stable version of Rust compiler) and calls `cargo doc` in that container.\n4. Upon success it moves the generated doc folder into the storage directory; upon failure it records the reason in a local Redis instance.\n\n#### License\n\nLicensed under the 3-clause BSD license. See [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdirk%2Fdoc_server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdirk%2Fdoc_server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdirk%2Fdoc_server/lists"}