オンラインドキュメントと日本語全文検索
自社では Sphinx というドキュメントツールを利用しているのですが、残念ながらこれに付属している検索機能の日本語検索はかなり厳しいです。また残念ながら Sphinx 開発側も検索周りを改善するという予定は直近ではないようです。 そして検索というのはとても難しい技術なため自分のような素人では導入して「普通に期待する動作」をさせるまでの距離はとても遠いです。 ただ、なんとかして日本語全文検索を実現したいという思いはここ10 年くらいずっと思っていました。これは自社の Sphinx テーマを作ってくれている社員ともよく話をしていたのですが、どうしてもリソースをつぎ込めずにいました。 まとめ日本語検索に対応している Meilisearch を採用したドキュメントスクレイパーの実行は GItHub Actions (Self-hosted Runner) を採用した自社 Sphinx テーマの検
Linux カーネルでの Sphinx 利用法を見てみよう - Hack like a rolling stone
年末カウントダウン Sphinx 連載、第3弾です。 一切下準備をせずに連載を始めたので、早くも息切れをしています。 だれかと約束をしたわけでもないのに急にアドベントカレンダー的なものを始めるのは、なんだか死に急いでいる気がしてきました。 今回は、今年から Sphinx の利用者に加わったある大型プロジェクトについて紹介しましょう。 そのプロジェクトとは、世界最大級の OSS のひとつである Linux カーネルです。 現在の Linux カーネルドキュメント 今年開催された LinuxCon Japan 2016 で Linux カーネルのドキュメントに Sphinx を使うという発表がありました。 Linus Torvalds氏が登壇、「約10週間のリリースサイクルは続く」 - クラウド Watch それから約 5ヶ月。現在はどうなっているのか見てみましょう。 Linux カーネルのド
Sphinx から完全に reStructuredText を追い出した話 - Hack like a rolling stone
いくつかの記事で紹介されているとおり、 recommonmark を使うと Sphinx で markdown を使うことができます。 Software Design 2016年4月号 Markdownで始めるSphinx MarkdownでSphinxできるようになったので試してみた（前編） - 意識の高いLISPマシン Markdownで書けるSphinxの構築 - Qiita しかし、recommonmark を利用しても、ドキュメント構造(toctree)を記述するためには部分的に reStructredText を使う必要がありました。 .. toctree chapter1 chapter2 chapter3 これは、文法を拡張する仕組みを持たない markdown の (commonmark の)構造上、仕方がないのですが、せっかく markdown でドキュメントを書いてい
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
2015/10/31に開催されたSphinxワークショップ@関西(https://japanunixsociety.doorkeeper.jp/events/32899)の発表資料です。Read less
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
設計ドキュメント作成ツールとしてSphinxとReVIEWについて調べた - 勘と経験と読経
主に作業メモ。ソフトウェア開発プロジェクトでは多かれ少なかれ様々なドキュメントを作成する。一般的にはMicrosoft OfficeなどのOAソフト(つまりWordやExcel)で文書を作成するのだけれども、これが非常に管理し難い。本当はWikiなどで管理するのがいいのだけれども、「納品」とか「持ち出し」を考えたときに、Wikiサーバを立てるのはあまりうまくない。というわけで以前に少しだけチェックしていたドキュメント作成ツールについて改めて調べてみた。 Sphinx Python製のドキュメント生成ツールである。reStructuredText記法という文法で記述したテキストツールをCUIでコンパイルすると、HTMLやPDFなどの各種ドキュメントを生成してくれる。 インストールは非常に容易 (Windowsだが、他のOSでも簡単なのだと思う) reStructuredText記法は、Wik
Sphinxの過去と、未来
Sphinxの過去と、未来¶ 著者: Georg Brandl 日付: 2012/12/25 原文: Sphinx, past and future 翻訳: @r_rudi, @shimizukawa このエントリーは日本語の Sphinx Advent Calendar 2012 に参加してくれないかというリクエストに応えて書いています。彼らはすごいよ！彼らは今年Sphinx Conferenceを開催して、イベントには70人もの人たちが集まったんだ！ Sphinx はいまや5歳になってるし、たぶん今までの歴史を振り返り、将来を語るのに良い時期じゃないかな。 このプロジェクトは2007年前半のいつ頃かに始まった。この投稿は私がPythonメーリングリストで見つけた中で一番古い。この時、Pythonのドキュメント作成のためのソースはLaTeXで書かれていた。私は科学的な文章を書くときには絶
"ドキュメントを部分的に公開/非公開にしてビルドする"の実用例 - logiqboard
Sphinx Advent Calendar 2012: 18日目 おひさしぶりのfeizです。久しぶりついでにはてブロに移行してみました。 先日、こんなcookbookを投稿しました。 ドキュメントを部分的に公開/非公開にしてビルドする :: ドキュメンテーションツール スフィンクス Sphinx-users.jp 仕事でお客さん向けのドキュメントを書いてると結構需要のある話なんじゃないかなーと思ってます。 ただ、cookbookには実際の利用例みたいなものをあまり入れられなかったので、この機会に実用例や設計手順をまとめてみようと思います。 前提とするシチュエーション 以下のようなシチュエーションを想定します。 とあるB2BサービスのAPIサーバーを書いている 自社(開発)→サービス元(サービス運用)→エンドユーザー(複数社) サービス元とエンドユーザーと自社内の3ロールにそれぞれドキュ
Django製サイトにSphinx製ドキュメントを導入する方法 - Make組ブログ
Django製のサイトにSphinx製のドキュメントをアッサリ導入する方法。 Sphinxドキュメントを http://example.com/docs/ に導入できる。 ユーザーグループのサイト作って、ドキュメントを/docs/以下に用意したい人とかが対象になると思う。 記事の内容はほとんどdjango-sphinxdocの導入方法。 これを使えばアッサリ解決できる。 環境 UbuntuServer==11.04 Python==2.7.1 Django==1.4 Sphinx==1.1.3 django-sphinxdoc==1.1 django-haystack==1.2.7 Whoosh==2.4.1 それぞれ pip とかでインストール。 sphinxdocの設定 基本的にはdjango-sphinxdocのドキュメントを参考に http://stefan.sofa-rocker
omakeもmakeも使わずに、Sphinxドキュメントの継続的ビルド - Study08.net 対シンバシ殲滅用人型機動兵器
新年あけましておめでとうございます。昨年一年は自分の(体重の)成長を実感できて大変残念ですね。この野郎。今年一年は減量の方ももうちょっと頑張ろうな。俺。 というわけでタイトルの話です。既にSphinxドキュメントで「.rst」ファイルが更新されたら、自動的にビルドを走らせる方法は偉大なる先人達の手によってとっくに道が開拓されているのですが、あえてまた開拓したいと思います。というか他の方法を僕がちゃんと理解できなかったので、僕の知ってる一番簡単な方法でやってみました。 先人達の足跡 特にやり方が決まってるいる話ではないので、omakeが好きな人、Makefileだけでやりたい人とかは下記記事が参考になると思います。 OMakeでSphinxドキュメントをビルドする - 偏った言語信者の垂れ流し omake を使わずに、Sphinx ドキュメントの継続的ビルド: Addicted To Ind
Sphinx で自動的にAPIリファレンスを作成したい - Study08.net 対シンバシ殲滅用人型機動兵器
今日はこのネタです。タイトルの通りなんですが、PythonでそもそもAPIリファレンス的なドキュメントをどうやって作ったら良いのか知りませんでした。 他の言語であれば下記のようなツールを過去に使った事がありました。 Java なら Javadoc Perl なら pod2html PHP なら PHPDocumentor (今ならもっと賢いツールありそうだけど。。。) Pythonなら? ではPythonであればどのような選択肢があるでしょう。調べた限りではまず下記のような選択肢がありました。 pydoc -w でHTML生成 (pydocで簡単なPythonファイルのドキュメントを作成する) Epydocを利用する (Epydoc - 偏った言語信者の垂れ流し) javadocやらphpdocmentorやらのように、まるっとソースからHTMLを生成するだけであれば、これで十分かもしれま
海外で作られたPython製ノベルゲーム制作ツール、Ren'Pyのドキュメント日本語訳(途中)を仮公開しました！ - プログラマ行進曲第二章
昨日2/12(土)にオラクル青山センターで開かれた"Sphinx + 翻訳 Hack-a-thon 2011.02"というイベントに参加してきました。このイベントは「Sphinx」*1というPython製のドキュメント生成ツールと「翻訳」に興味がある人を対象にした勉強会で、色々思うところがあってこのたび参加してきました。何故参加したか？といったことや参加するに至った経緯は別のエントリでまとめて公開する予定なので、後で合わせてそちらも読んでいただければと思います。 前置きが長くなりましたが、本題です。あまりに長くなったので、要点だけ知りたい方は最後のまとめまでスキップしてください。 前述したイベント、"Sphinx + 翻訳 Hack-a-thon 2011.02"で私はRen'PyというPython製ノベルゲーム制作ツールのドキュメントを翻訳しようと思って参加しました。そしてイベント参加者
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ボクとSphinxとVimと。