オンラインドキュメントと日本語全文検索
自社では Sphinx というドキュメントツールを利用しているのですが、残念ながらこれに付属している検索機能の日本語検索はかなり厳しいです。また残念ながら Sphinx 開発側も検索周りを改善するという予定は直近ではないようです。 そして検索というのはとても難しい技術なため自分のような素人では導入して「普通に期待する動作」をさせるまでの距離はとても遠いです。 ただ、なんとかして日本語全文検索を実現したいという思いはここ10 年くらいずっと思っていました。これは自社の Sphinx テーマを作ってくれている社員ともよく話をしていたのですが、どうしてもリソースをつぎ込めずにいました。 まとめ日本語検索に対応している Meilisearch を採用したドキュメントスクレイパーの実行は GItHub Actions (Self-hosted Runner) を採用した自社 Sphinx テーマの検
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
Sphinx + Jenkins で始めるドキュメントの継続的インテグレーション | TECHSCORE BLOG | TECHSCORE BLOG
はじめに はじめまして、白川です。 システム開発では、多かれ少なかれドキュメントを作成する必要があると思います。 Word、Excelによって作成することが大体と思いますが、いろいろと問題点があるな、と感じるようになりました。 文書自体の整形（改行や改ページ、インデント、文字サイズ）が大変 仕様書が膨大になってくると、何がどこにあるかわからなくなり、内容のメンテナンス・維持が難しくなる 結果として、内容の陳腐化を招いてしまい、 ドキュメントと現実の仕様に差異が発生して、役に立たないドキュメントとなってしまいます。 そうなると、システムの仕様を把握するために、ソースコードをみないといけなくなりますし、 知見が担当者に依存してしまい、担当者が不在になると分からないことが多くなってしまいます。 それを防ぐために、 Python製のドキュメントビルダーであるSphinxを現在試しています。 Sph
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
