# こえどLUG 報告 Hiroshi Miura 14, Jan., 2023 slide https://hackmd.io/@miurahr/H1Ba4Tyoj --- ## 近況 - 12月上旬、加古川市でSotM Japan 2022開催 - Gradle-Sphinx プラグインをリリース - Docuboxプロジェクト開始 --- ## ドキュメント(マニュアル)作成ツールについて - みなさん、ドキュメント作成ツールは、何を使いますか？ - HTMLで公開する、PDFでダウンロードできるもの。 --- ## Sphinx - Pythonのマニュアル生成のために誕生 - 多言語ドキュメントに対応 - 入力フォーマットには、ReStructured Textが標準、Markdownも対応 - HTML, PDF, ePubなど各種フォーマット --- ## MkDocs - Pythonのドキュメントソリューション - Markdownで簡易にHTML作成できる --- ## DocBook - XMLで、書籍グレードの文書を作成できる。 - HTML生成, LaTeX経由でPDFを生成 - 文書向上を厳格に管理できる --- ## Python以外の環境のとき - 決定版のテクニカル文書ビルダーがない! - Java,Kotlin: DocBook? XML! - Ruby: Asciidoc? --- ## JavaのOSSプロジェクトで開発者むけ文書かきたい - SphinxをJavaのビルダーからつかいたい - 他のメンバーも使えるMarkdownを使いたい - Gradle: Java,Kotlinのビルダ - プラグインがある → 開発停止中 --- ## 開発停止してたプラグインがやっていること - Pythonには、プログラムをバイナリ実行ファイル化するツールがある - PythonとSphinxと拡張機能、テーマを実行フィアル化 - ダウロードして実行できるようにする --- ## やってみよう - Sphinx-standalone プロジェクト - https://codeberg.org/miurahr/sphinx-standalone - 約35-45MBくらいのバイナリになる。 - Linux, macOS, Windows --- ## Gradle Sphinx plugin - 開発停止したので、forkして改良して登録した - https://plugin.gradle.org で検索してください。 --- ## バイナリ化、可能性ある! - Docubox プロジェクト - ドキュメント系のコマンドを沢山まとめて1バイナリに - 実行ファイルの名前で動作がかわる。 - ドキュメント生成用のBusyBoxようなもの - DocuBox - The swiss army knife for document solution. --- ## DocuBox - https://docubox.readthedocs.io/ - sphinx-quickstart, sphinx-build, mkdocs など として動作する --- ---