{"id":21432454,"url":"https://github.com/gagolews/rd2rst","last_synced_at":"2025-06-13T06:02:43.897Z","repository":{"id":54479266,"uuid":"287923727","full_name":"gagolews/Rd2rst","owner":"gagolews","description":"[EXPERIMENTAL] Convert an R package's documentation to Markedly- (MyST) or reStructuredText (rST)","archived":false,"fork":false,"pushed_at":"2024-07-10T20:19:16.000Z","size":91,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-23T08:43:13.247Z","etag":null,"topics":["documentation","knitr","myst","pandoc","r","restructuredtext","rst","sphinx"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gagolews.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS","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}},"created_at":"2020-08-16T10:43:35.000Z","updated_at":"2024-07-10T20:19:19.000Z","dependencies_parsed_at":"2024-07-10T23:26:17.487Z","dependency_job_id":"90f25019-e519-4051-a415-4954681c3996","html_url":"https://github.com/gagolews/Rd2rst","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/gagolews%2FRd2rst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gagolews%2FRd2rst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gagolews%2FRd2rst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gagolews%2FRd2rst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gagolews","download_url":"https://codeload.github.com/gagolews/Rd2rst/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243945321,"owners_count":20372890,"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":["documentation","knitr","myst","pandoc","r","restructuredtext","rst","sphinx"],"created_at":"2024-11-22T23:18:36.493Z","updated_at":"2025-03-16T22:35:24.748Z","avatar_url":"https://github.com/gagolews.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `Rd2rst` [EXPERIMENTAL]\n## Convert R package Documentation to Markedly- (MyST) or reStructuredText (rST)\n\n\u003e Note: rST support is deprecated and probably doesn't work anymore.\n\nAuthor: [Marek Gagolewski](https://www.gagolewski.com)\n\nSystem requirements: `pandoc`\n\n\u003e Caution: not tested on other systems.\nThis package in its current version is not intended to serve any\npurpose other than generating the R API documentation\nof the\n[genieclust](https://genieclust.gagolewski.com),\n[stringi](https://stringi.gagolewski.com),\n[stringx](https://stringx.gagolewski.com),\nand [realtest](https://realtest.gagolewski.com)\npackages.\n\n\nI'm applying a super-lazy approach here: the complete manual bundle\nis generated from the HTML version as produced by `R CMD INSTALL \u003cpkg\u003e --html`.\nIt's because `tools::Rd2HTML()` does a pretty good job\noutputting well-structured and easily-digestible source files.\nIt also does cross-referencing right.\nHowever, it's far from perfect with regards to mathematical formulae.\n\nI have no time to implement a full-fledged parser.\nFeel free to contact me to discuss further ideas and maybe\nwe can come up with something more useful together.\n\nAlso, it would be nice to implement a standalone Sphinx domain for R.\nSee \u003chttps://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html\u003e\nand \u003chttps://www.sphinx-doc.org/en/master/extdev/domainapi.html\u003e.\nWant to do it together? Drop me an email. Cheers.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgagolews%2Frd2rst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgagolews%2Frd2rst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgagolews%2Frd2rst/lists"}