{"id":36418191,"url":"https://github.com/devives/rst-doclet","last_synced_at":"2026-01-11T17:01:23.215Z","repository":{"id":223164836,"uuid":"749411711","full_name":"devives/rst-doclet","owner":"devives","description":"Doclet for JavaDoc Tool, generating reStructuredText for Sphinx.","archived":false,"fork":false,"pushed_at":"2025-10-19T19:18:21.000Z","size":2819,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-20T02:26:03.882Z","etag":null,"topics":["doclet","javadoc","restructuredtext","rst","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devives.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-GPL-3.0","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":"2024-01-28T14:10:44.000Z","updated_at":"2025-10-19T19:18:26.000Z","dependencies_parsed_at":"2024-04-20T20:25:23.763Z","dependency_job_id":"0beb4925-b28f-4ac3-a384-9de71a19cad6","html_url":"https://github.com/devives/rst-doclet","commit_stats":null,"previous_names":["devives/rst-doclet"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/devives/rst-doclet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devives%2Frst-doclet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devives%2Frst-doclet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devives%2Frst-doclet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devives%2Frst-doclet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devives","download_url":"https://codeload.github.com/devives/rst-doclet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devives%2Frst-doclet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28314255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T14:58:17.114Z","status":"ssl_error","status_checked_at":"2026-01-11T14:55:53.580Z","response_time":60,"last_error":"SSL_read: 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":["doclet","javadoc","restructuredtext","rst","sphinx"],"created_at":"2026-01-11T17:00:57.246Z","updated_at":"2026-01-11T17:01:23.183Z","avatar_url":"https://github.com/devives.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"==========================\nRstDoclet for JavaDoc Tool\n==========================\n\nThis project is the extension of `Javadoc Tool \u003chttps://www.oracle.com/java/technologies/javase/javadoc-tool.html\u003e`_. \n\nIt's Implement `Doclet \u003chttps://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html\u003e`_ \nwitch generates `reStructuredText \u003chttps://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html\u003e`_\nfiles based on `javadoc \u003chttps://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html\u003e`_\ncomments in code.\n\nGenerated ``*.rst`` files can be published using \n`Sphinx \u003chttps://www.sphinx-doc.org/en/master/\u003e`_. \n\n.. note::\n\n   The `javasphinx \u003chttps://bronto-javasphinx.readthedocs.io/en/latest/\u003e`_ extension must be installed in Sphinx.\n\nQuick Start\n-----------\n\n1. Add ``mavencentral()`` repository to your root ``build.gradle``:\n\n   .. code:: gradle\n\n      repositories {\n          mavenCentral()\n      }\n#. Add ``rstDoclet``configuration to configurations:\n\n   .. code:: gradle\n\n      configurations {\n          rstDoclet\n      }\n#. Add the library of required java version to the dependencies:\n\n   Java 8\n\n   .. code:: gradle\n\n      dependencies {\n          rstDoclet('com.devives:devive-rst-doclet-jdk8-all:0.4.5')\n      }\n\n   Java 11\n\n   .. code:: gradle\n\n      dependencies {\n          rstDoclet('com.devives:devive-rst-doclet-jdk11-all:0.4.5')\n      }\n\n   Java 17\n\n   .. code:: gradle\n\n      dependencies {\n          rstDoclet('com.devives:devive-rst-doclet-jdk17-all:0.4.5')\n      }\n\n   Java 21\n\n   .. code:: gradle\n\n      dependencies {\n          rstDoclet('com.devives:devive-rst-doclet-jdk21-all:0.4.5')\n      }\n#. Register gradle task ``javadoc4sphinx``depends java version:\n\n   Java 8\n\n   .. code:: gradle\n\n      tasks.register('javadoc4sphinx', Javadoc) {\n          description = 'Generate rst files based on javadoc comments in code.'\n          group = 'documentation'\n          source = sourceSets.main.allJava\n          classpath = configurations.compileClasspath\n          destinationDir = file(\"$docsDir/javadoc4sphinx\")\n          failOnError = true\n          options.docletpath = configurations.rstDoclet.files as List\n          options.doclet = \"com.devives.rstdoclet.RstDoclet\"\n          options.encoding = \"UTF-8\"\n          options.showFromPackage()\n          (options as CoreJavadocOptions).addStringOption(\"packageindexfilename\", \"package-index\")\n      }\n\n   Java 11\n\n   .. code:: gradle\n\n      List\u003cString\u003e exportsList = [\n              '--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit.taglets=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit.util=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.formats.html=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.formats.html.markup=ALL-UNNAMED',\n      ]\n\n      tasks.register('javadoc4sphinx', Javadoc) {\n          description = 'Generate rst files based on javadoc comments in code.'\n          group = 'documentation'\n          source = sourceSets.main.allJava\n          classpath = configurations.compileClasspath\n          destinationDir = file(\"$docsDir/javadoc4sphinx\")\n          failOnError = true\n          options.docletpath = configurations.rstDoclet.files as List\n          options.doclet = \"com.devives.rstdoclet.RstDoclet\"\n          options.encoding = \"UTF-8\"\n          options.showFromPackage()\n          (options as CoreJavadocOptions).addStringOption(\"packageindexfilename\", \"package-index\")\n          (options as CoreJavadocOptions).setJFlags(exportsList)\n      }\n\n   Java 17\n\n   .. code:: gradle\n\n      List\u003cString\u003e exportsList = [\n              '--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit.taglets=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit.util=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.formats.html=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.formats.html.markup=ALL-UNNAMED',\n      ]\n\n      tasks.register('javadoc4sphinx', Javadoc) {\n          description = 'Generate rst files based on javadoc comments in code.'\n          group = 'documentation'\n          source = sourceSets.main.allJava\n          classpath = configurations.compileClasspath\n          destinationDir = file(\"$docsDir/javadoc4sphinx\")\n          options.docletpath = configurations.rstDoclet.files.asType(List)\n          options.doclet = \"com.devives.rstdoclet.RstDoclet\"\n          options.encoding = \"UTF-8\"\n          options.windowTitle(null)\n          options.showFromPackage()\n          failOnError = false\n          (options as CoreJavadocOptions).addStringOption(\"packageindexfilename\", \"package-index\")\n          (options as CoreJavadocOptions).setJFlags(exportsList)\n      }\n\n   Java 21\n\n   .. code:: gradle\n\n      List\u003cString\u003e exportsList = [\n              '--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED',\n              '--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED',\n              '--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit.taglets=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit.util=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.formats.html=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.formats.html.markup=ALL-UNNAMED',\n              '--add-exports=jdk.javadoc/jdk.javadoc.internal.doclets.toolkit.builders=ALL-UNNAMED',\n      ]\n\n      List\u003cString\u003e opensList = [\n              '--add-opens=jdk.javadoc/jdk.javadoc.internal.doclets.formats.html=ALL-UNNAMED',\n      ]\n\n      tasks.register('javadoc4sphinx', Javadoc) {\n          description = 'Generate rst files based on javadoc comments in code.'\n          group = 'documentation'\n          source = sourceSets.main.allJava\n          classpath = configurations.compileClasspath\n          destinationDir = file(\"$docsDir/javadoc4sphinx\")\n          options.docletpath = configurations.rstDoclet.files.asType(List)\n          options.doclet = \"com.devives.rstdoclet.RstDoclet\"\n          options.encoding = \"UTF-8\"\n          options.windowTitle(null)\n          options.showFromPackage()\n          failOnError = false\n          (options as CoreJavadocOptions).addStringOption(\"packageindexfilename\", \"package-index\")\n          (options as CoreJavadocOptions).setJFlags(exportsList + opensList)\n      }\n#. Reload All Gradle Projects.\n#. Execute gradle task ``documentation \\ javadoc4sphinx``.\n#. Find generated files at ``$project.build/docs/javadoc4sphinx/``.\n\nComplete example projects\n-------------------------\n\nAre placed at `GitHub \u003chttps://github.com/devives/rst-doclet/tree/main/usage/gradle\u003e`_.\n\nLicense\n-------\n\nThe code of project distributed under the GNU General Public License version 3 or any later version.\nThe source code is available on `GitHub \u003chttps://github.com/devives/rst-doclet\u003e`_.\n\nLinks\n-----\n\n* `Javadoc Tool \u003chttps://www.oracle.com/java/technologies/javase/javadoc-tool.html\u003e`_\n* `ReStructuredText Document \u0026 Builder for Sphinx \u003chttps://github.com/devives/rst-document-for-sphinx\u003e`_\n* `ReStructuredText Document \u0026 Builder \u003chttps://github.com/devives/rst-document\u003e`_\n\n.. footer::\n\n   This document generated using `this code \u003chttps://github.com/devives/rst-doclet/blob/main/jdk8/src/test/java/com/devives/rstdoclet/ReadMeGenerator.java\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevives%2Frst-doclet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevives%2Frst-doclet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevives%2Frst-doclet/lists"}