LoginSignup
5

More than 5 years have passed since last update.

最近のSphinx

Last updated at Posted at 2016-07-11

はじめに

SphinxをWordやLaTexの代替として使いたいなと思っているという前提で現状できることをまとめました。図表や数式を含むある程度の量の文章(投稿論文や学会要旨ほど厳密にフォーマットは決まってなくて,そこそこ長い文章を想定。実験レポートとか報告書とか)を書くときに必要な機能についてのみまとめてます。

ここに書いた以外でできることもたくさんあるので,詳細はユーザーページ等で確認して頂いたほうがいいと思います。http://docs.sphinx-users.jp/index.html

現状できること

1.4.4を使ってできたことを勝手にまとめます。

  • 章,節,小節などの見出しのレベル設定
    • 前からできる。
  • 図表番号,コードリストの参照
    • :numref:使えばソースファイルが分割されてても参照可能。
  • 参考文献の参照
    • 参考文献もソースファイルが分割されてても参照可能。
    • latexpdfjaつかって,howtoにしてコンパイルするとbibnameでビルドがこけるかも。sphinxhowto.clsを修正するかbibnameを定義する必要がある。
  • 式番号
    • 式番号は同一ソースファイルからしか参照できなさそう。
    • 複数行の式を1つの ..math::でかくと式番号は1個しかつかない。個別につけられるのか?
  • 細かいレイアウトの設定
    • ややこしいのでレイアウトとかを細かく修正しようとするのはやめたほうが無難。

まとめ

これだけちゃんとできたら,大抵の技術文章書くのに困らないと思います。だけど数式が大量にあるときは最初からLaTeXで書くのが正解だと思う。

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
5