{"id":13503020,"url":"https://github.com/Ruin0x11/oxidoc","last_synced_at":"2025-03-29T13:30:33.000Z","repository":{"id":77938928,"uuid":"83190370","full_name":"Ruin0x11/oxidoc","owner":"Ruin0x11","description":"A command line interface to Rust documentation","archived":true,"fork":false,"pushed_at":"2018-11-05T04:45:03.000Z","size":513,"stargazers_count":102,"open_issues_count":8,"forks_count":15,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-10-31T22:33:35.331Z","etag":null,"topics":["rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/Ruin0x11.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2017-02-26T07:12:37.000Z","updated_at":"2024-05-22T07:40:48.000Z","dependencies_parsed_at":"2023-08-26T07:30:42.376Z","dependency_job_id":null,"html_url":"https://github.com/Ruin0x11/oxidoc","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/Ruin0x11%2Foxidoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruin0x11%2Foxidoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruin0x11%2Foxidoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruin0x11%2Foxidoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ruin0x11","download_url":"https://codeload.github.com/Ruin0x11/oxidoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246190168,"owners_count":20737985,"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":["rust"],"created_at":"2024-07-31T22:02:33.708Z","updated_at":"2025-03-29T13:30:32.611Z","avatar_url":"https://github.com/Ruin0x11.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# oxidoc\n`oxidoc` is a command-line interface to Rust documentation.\n\n![screenshot](data/screenshot.png)\n\nIt is alpha-quality software, so some documentation may not be indexed or other strange things may happen.\n\n## Building\n\nBefore building the crate, make sure that you have install all needed dependencies in the system:\n* CMake\n* ncurses header files\n\nTo intall them in Debian GNU/Linux or Ubnutu, do the following:\n```\napt-get install cmake libncursesw6-dev\n```\n\nBuild the crate:\n```\ncargo build --release\n```\nIn order to generate documentation for the standard library, the `RUST_SRC_PATH` environment variable has to be set with the path of the Rust source code.\n\nGenerate documentation for all crates in `~/.cargo/registry/src` and the standard library:\n```\noxidoc -g all\n```\nGenerate documentation for the specified crate source directory:\n```\noxidoc -g ~/build/oxidoc/\n```\n\nThe generated documentation currently lives in `~/.cargo/registry/doc`.\n\n## Usage\nProvide either an identifier or a partially/fully qualified module path as a search query:\n```\noxidoc rand\noxidoc vec::Vec\noxidoc serde::de::DeserializeOwned\n```\n\n## TODO\n- Documentation for struct/trait subitems\n- Indexing documentation when a type is glob imported from another module\n- Partial/fuzzy identifier matching\n- Searching by type signature\n- Filtering by unsafety/trait\n- Showing lifetime information for module paths\n- Documenting generics\n- Handling non-standard crate entry points\n- Provide web browser fallback when emitting documentation with HTML/embedded images\n- Probably many other things.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRuin0x11%2Foxidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRuin0x11%2Foxidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRuin0x11%2Foxidoc/lists"}