しおしお

IntelliJ IDEAのことなんかを書いてます

Sphinx

sphinx-javalinkを使ってSphinxドキュメントからJavadocへのリンクをはってみる

Sphinxで作ったドキュメントから、Javadocへのリンクをはれる拡張のsphinx-javalinkの使い方。 ※昔書いた、sphinxからjavadocへのリンク簡単に貼れる拡張 - しおしおのほうが使い方は簡単なんだけど、Java8で作られたドキュメントへのリンクがうまくできない…

sphinxからjavadocへのリンク簡単に貼れる拡張

Sphinxのドキュメントから、Javadocページ編のリンクを貼るのを簡単にするjavasphinx User’s Guide — javasphinx 0.9.8 documentationという拡張です。この拡張を使うと、Javadocのトップページへのパスをconf.pyに設定して置けるので、 ここのページではク…

vimにrivプラグイン入れたらSphinxの編集楽になった

VimでSphinxなドキュメント書いてて、grid-table の編集しんどくなったから、ぐぐってみたらrivなるよさ気なプラグイン見つけた。grid tableだと枠線綺麗に書かないと行けないんだけど、コマンド一発で綺麗にしてくれたり、行の追加してくれたりかなり幸せな…

IntelliJでSphinxドキュメントを書いてみよう

IntelliJでSphinxを使う手順のまとめ。 前提 IntelliJでSphinxを使うための必要な下記のモジュールのインストールができていること。 Python Sphinx IntelliJのPythonプラグイン IntelliJにPythonプロジェクトの作成 Sphinxを利用するためには、Pythonプロジ…

Sphinxのソースコード表示を消す方法

Sphinxの小ネタ。Sphinxをhtmlでビルドすると、サイドバーに「ソースコードを表示」なるリンクが出力されます。 このリンクをクリックすると今表示されているページのソース(rstの内容)が見れます。ただ、rstの内容は見せたくないって場合があるので、その場…

GradleでSphinxをビルドしてみた。

お仕事でSphinxでドキュメント書いてて、Gradleでビルドしてるときたら、SphinxもGradleからビルドしないとダメだよねってことでやってみた。お試しプロジェクトの構成はこんな感じで、プロジェクト直下のdocディレクトリにドキュメントが格納されていると。…