ライオンの顔像よくある質問解答

以下にライオンの顔像に関するよく見られる質問リストを示す.いつでも新しい参加作品を推薦してください！

私はどうすれば…。

それは.LaTeXなしでPDFファイルを作成しますか？

rinohtype LaTeXビルダの一時的な代替品とすることができるPDFビルダを提供する。

それは.部署番号は手に入れましたか。

LaTeX出力では自動的ですHTMLに対しては :numbered: オプションを追加します toctree コマンドでは，開始番号を指定する位置を指定する.

それは.生成されたHTML文書の外観をカスタマイズしていますか？

使用テーマは、ご参照ください HTMLトピック それがそうです。

それは.グローバル置換を追加しますか？それとも含まれますか？

これらを追加して rst_prolog あるいは…。 rst_epilog 値を配置する。

それは.サイドバーにカタログツリー全体が表示されていますか？

使用 toctree カスタマイズされたレイアウトテンプレートで呼び出すことができ、 sidebartoc 立ちはだかっています。

それは.私自身の拡張を書きますか？

ご参照ください チュートリアルを拡張する それがそうです。

それは.MoinMoinマークを使用して既存の文書から変換しますか？

最も簡単な方法はxhtmlに変換してから変換することです xhtml to reST それがそうです。あなたはまだタグクラスのような内容が必要ですが、タイトルとコード例は明確に見えます。

より多くの拡張およびその他の貢献については、参照されたい sphinx-contrib 貯蔵庫です。

ライオンの顔像と..を。

“文書”を読む

Read the Docs Sphinxに基づく文書管理サービスです。これらは、Shinx文書をホストし、バージョンサポート、PDF生成など、多くの他の機能をサポートします。♪the Getting Started 案内書はいいスタート地点です。

エビドック

3つ目の拡張が提供しています api role これは，与えられた識別子のEpydocのAPI文書を参照する.

酸素.酸素

マイケル·ジョーンズはdoxygenへのRest/Sphinx橋を開発しています breathe それがそうです。

SCons

Glenn HutchingsはSphinx文書を構築するためのSCons構築スクリプトを作成しました；https：//bitbucket.org/zondo/sphinx-scons

PyPI

ジャニス·ライデルは setuptools command Sphinx文書をhttps：//pythonhosted.org/にあるPyPIパッケージに自動的にアップロードします。

GitHubページ

つけてください sphinx.ext.githubpages あなたのプロジェクトです。それはあなたがGitHubページで文書を公開することを可能にします。これは，HTML文書を構築する際にGitHubページのためのヘルプファイルを自動的に生成する.

MediaWiki

Kevin Dunnの項目であるhttps：//bitbucket.org/kevindunn/sphinx-wiki/wiki/Homeを参照してください。

Google分析

カスタマイズされたものを使うことができます layout.html テンプレートは，以下のとおりである.

{% extends "!layout.html" %}

{%- block extrahead %}
{{ super() }}
<script>
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'XXX account number XXX']);
  _gaq.push(['_trackPageview']);
</script>
{% endblock %}

{% block footer %}
{{ super() }}
<div class="footer">This page uses <a href="https://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script>
  (function() {
    var ga = document.createElement('script');
    ga.src = ('https:' == document.location.protocol ?
              'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    ga.setAttribute('async', 'true');
    document.documentElement.firstChild.appendChild(ga);
  })();
</script>
</div>
{% endblock %}

Google検索

Sphinxの内蔵検索機能をGoogle Searchに置き換えるには、以下の操作を実行してください。

1. Https：//cse.google.com/cse/allに移ってGoogle検索コードセグメントを作成します。

2. コード片をコピーして貼り付けます _templates/searchbox.html Sphinxプロジェクトでは

   <div>
      <h3>{{ _('Quick search') }}</h3>
      <script>
         (function() {
            var cx = '......';
            var gcse = document.createElement('script');
            gcse.async = true;
            gcse.src = 'https://cse.google.com/cse.js?cx=' + cx;
            var s = document.getElementsByTagName('script')[0];
            s.parentNode.insertBefore(gcse, s);
         })();
      </script>
     <gcse:search></gcse:search>
   </div>
   

3. 増列する. searchbox.html 致す html_sidebars 値を配置する。

ライオンの顔像VS Docutils

TL；DR： Docutils ReStrutiredTextを複数の出力フォーマットに変換する.Sphinxはdocutils上に構築され，交差引用とインデックスの文書本文の構築を許可する.

docutils __は、平文文書を他のより豊富なフォーマットに変換するための文書処理システムである。あるように `docutils documentation`_ _、docutils使用 読み手 文書を読むには 解析器 平文形式を異なるタイプに解析するために使用される ノード.ノード そして、 作家 この木は様々な文書形式で出力される.Docutilsは平文形式の解析器を提供します `reStructuredText`_ _-他のものだが、 out-of-tree Sphinxを含む解析器を実現しました Markdown parser それがそうです。一方，HTML，LaTeX，マニュアルページ，Open Document Format，XMLなど，様々なフォーマットのコンパイラを提供している.

docutils exposes all of its functionality through a variety of `front-end tools`__, such as rst2html, rst2odt and rst2xml. Crucially though, all of these tools, and docutils itself, are concerned with individual documents. They don't support concepts such as cross-referencing, indexing of documents, or the construction of a document hierarchy (typically manifesting in a table of contents).

SphinxはDocutilのリーダーと解析器を利用して自分の 建設者. それがそうです。そこでライオンの顔像はいくつか包装されています 作家 Docutilsが提供します。これにより、Sphinxは、上述したような特性のようなdocutilsにおいて実質的に実現不可能な多くの特性を提供することができる。

EPub情報

以下のリストは、epubファイルの作成に関するいくつかのプロンプトを提供します。

• テキストをいくつかの文書に分割する.個々のHTML文書が長いほど，電子書籍リーダがそれらを提示するのに要する時間が長くなる.極端な場合、レンダリングには1分もかかるかもしれない。

• できるだけ値上げを最小限にしてください。これによりレンダリング時間も節約できる.

• いくつかのリーダでは、CSSを使用して埋め込みまたは外部フォントを使用することができます @font-face 指令する。これは.。 極 コードリストは、通常、右距離で切り出されるコードリストに非常に有用である。デフォルトCourierフォント(または変形体)はかなり広く、1行は最大60文字しか表示できません。これをより狭いフォントに置き換えると、1行でより多くの文字を得ることができます。使うこともできます FontForge 自由フォントの幅の狭い変異体を作りました私の例では、一行は最大70文字を含むことができる。

  合理的な結果が得られるまで試してみる必要があるかもしれない。

• 作成したepubをテストします。複数の代替案を使用することができます。私が知っているのは Epubcheck, Calibre, FBreader (CSSは提示されていないにもかかわらず)、 Bookworm. BookWormでは、https：//code.google.com/archive/p/triepressからソースコードをダウンロードし、ご自身のローカルサーバを実行することができます。

• 大型浮動divは正しく表示されなかった。それらが複数のページをカバーする場合、divは1ページ目にのみ表示される。この場合、コピーすることができます epub.css 従 sphinx/themes/epub/static/ ディレクトリをローカルにコピーします _static/ ディレクトリは、フローティング設定を削除します。

• 外部に挿入されたファイル toctree 指示は手動で含まれなければならない。これは，語彙表や索引のような付録に適用されることがあるご利用いただけます epub_post_files 選択します。

• Epub表紙ページの処理は，画像経路を自動解析して画像を入れるのとは異なる. _images カタログです。Epub表紙ページについては、写真を置いてください html_static_path ディレクトリ中の完全パスはそれを参照する. epub_cover オプションを構成します。

• kindlegen コマンドは、EPUB 3結果ファイルを変換することができます .mobi Kindleのファイルです。手に入れることができます yourdoc.mobi 因る _build/epub 以下のコマンドの後：

  $ make epub
  $ kindlegen _build/epub/yourdoc.epub
  

  Kindlegenは周囲に章タイトルのある文書を受け入れないように命令した toctree 指示：

  Section Title
  =============
  
  .. toctree::
  
     subdocument
  
  Section After Toc Tree
  ======================
  

  Kindlegenは，すべての文書が順に配列されていると仮定しているが，生成された文書は複雑なkindlegenを持つ：

  ``parent.xhtml`` -> ``child.xhtml`` -> ``parent.xhtml``
  

  以下のようなエラーが発生した場合、文書構造を修復してください。

  Error(prcgen):E24011: TOC section scope is not included in the parent chapter:(title)
  Error(prcgen):E24001: The table of content could not be built.
  

テクスチャ情報情報

Infoファイルを読み込むための2つの主なプログラムがあります info GNU Emacsです♪the info プログラムの機能は少ないが，多くのUnix環境で利用可能であり，端末から高速にアクセス可能である.Emacsは、より良いフォントおよび色表示を提供し、幅広いカスタマイズをサポートしています(もちろん)。

リンクを表示する

生成されたInfoファイルは、参照の表示方法である注目すべき問題に遭遇する可能性がある。Infoファイルのソースコードを読むと、この部分への参照は以下のようになります。

* note Displaying Links: target-id

独立したリーダーでは info なお、参照される表示方式は、ソースにおける表示方式と同様である。一方，Emacsはデフォルトで置き換える. *note: 使用 see 隠されています target-id それがそうです。例：

リンクを表示する

Emacsは参照の適切な行動が変数に依存することを示している. Info-hide-note-references それがそうです。もし設定が hide Emacsは隠れます *note: 部分和 target-id それがそうです。これは、通常、リンクがよく使用され、この制限は考慮されていないので、Sphinxベースの文書を見るのに最適な方法である。しかし，この変数を変更することはすべてのInfo文書の表示方式に影響を与え，その振舞いを考慮することが多い.

EmacsがSphinxで生成されたInfoファイルを値を使用して表示したい場合 hide 上の Info-hide-note-references 他のすべてのInfoファイルのデフォルト値と、以下のEmacs Lispコードを起動ファイルに追加してみてください。 ~/.emacs.d/init.el それがそうです。

(defadvice info-insert-file-contents (after
                                      sphinx-info-insert-file-contents
                                      activate)
  "Hack to make `Info-hide-note-references' buffer-local and
automatically set to `hide' iff it can be determined that this file
was created from a Texinfo file generated by Docutils or Sphinx."
  (set (make-local-variable 'Info-hide-note-references)
       (default-value 'Info-hide-note-references))
  (save-excursion
    (save-restriction
      (widen) (goto-char (point-min))
      (when (re-search-forward
             "^Generated by \\(Sphinx\\|Docutils\\)"
             (save-excursion (search-forward "\x1f" nil t)) t)
        (set (make-local-variable 'Info-hide-note-references)
             'hide)))))

注意事項

Texinfoファイルを作成するには、以下の注釈が役立つかもしれません。

• それぞれの部分は異なるものに対応しています node Infoファイルにあります。

• にせものをする. (: )料理単項や外部参照では正しく変換できない.彼らは番号を交換されます (; ）。

• ある公式のURIスキームを使用して外部Infoファイルへのリンクを作成することができる info それがそうです。例えば：

  info:Texinfo#makeinfo_options
  

• 内連マーク.

  の標準フォーマット *strong* そして _emphasis_ パラメータ名や他の値をマークするために用いた場合，不明確な出力を招く可能性がある.これはかなり一般的な方法であるため、デフォルトフォーマットが変更された emphasis そして strong ここでは次のように示します `literal' s.

  以下を追加することにより、標準フォーマットを再有効化することができます conf.py **

  texinfo_elements = {'preamble': """
  @definfoenclose strong,*,*
  @definfoenclose emph,_,_
  """}