問題タブ [python-sphinx]

問題: reStructuredTextを使用して「パラレル テキスト」を書き込もうとしています。「パラレル テキスト」とは、テキストが 2 段組みになっている、注釈付きのフィクション作品のようなものを意味します。左欄が本文、右欄が解説です。そこから HTML と Latex ドキュメントを生成するためにsphinxを使用します。

次の要件があります。

1. 前述のように、テキストを 2 つの列 (1 つは本文用、もう 1 つは注釈用) にタイプセットできるはずです。
2. 注釈は「文レベル」にすることができ、常に「段落レベル」であるとは限りません。つまり、段落内のさまざまな文または段落全体に注釈を付けたいと考えています。
3. 出力 HTML と Latex にはメイン テキストのみが含まれるように、すべての注釈をオフにするモードがあると便利です。この場合、コラムだけでなく、媒体の「不動産」全体を使用できるようにしたいと考えています。
4. 可能であれば、「注釈のリスト」機能があると非常に便利です。

私は reStructuredText と Sphinx にはかなり慣れていませんが、Python にはかなりの経験があります。自分のやりたいことを実現するためのアイデアを探しています。私は reStructuredText について読んでおり、Sphinx 拡張機能の作成についても読んでいるので、Sphinx の拡張機能を作成することは問題外ではありません。

誰かが以前に似たようなことをしたことがありますか?

ありがとう！

を使用してビルドしようとしてsphinx-build . docいますが、警告が表示されます:

その理由は何ですか？

Sphinx から生成されたテーブルは、次のテーブルの HTML コードを生成するため、きれいではないと思います。

たとえば、シマウマのテーブルなど、きれいなものに変えるにはどうすればよいですか?

HTMLで生成されたhtmlにはjQueryがあり、このサイトによるとたった1行のコードでゼブラテーブルが作れますが、jQueryを使ってゼブラテーブルを作る方法がわかりません。

• Q: Sphinx で jQuery を使用するにはどうすればよいですか?
• Q: Sphinx でゼブラ テーブルを作成する他の方法はありますか?

ReST/Sphinxを使用してRESTful Webサービスのメソッド/URLをマークアップする最良の方法は何ですか? 可能なパラメーター、HTTP メソッド、ヘッダー、および本文コンテンツを使用して URL をマークアップするのに適したデフォルト ドメインはありますか?

次のようなもの：

このようなものは既に存在していますか、使用可能なデフォルトの拡張機能の 1 つですか、それとも自分で作成する必要がありますか?

reStructured Text の横にテキストが表示された画像を表示する最良の方法を探しています。それがどのように行われたかを示すと称するサイトをいくつか見つけましたが、実際に機能する例を示しているサイトはありません。いくつかは、失敗例と思われるものを示しています。私は実際に Sphinx (v0.6.6) を使用しており、付属の「ネイティブ」CSS を必要以上に改変しないようにしたいと考えています。

モジュールごとに 1 つの sphinx プロジェクトを作成する必要があります。

各モジュールは、会社情報、ライセンスなどのいくつかの共通の rst を共有します。

私のプロジェクトツリーは次のようなものです:

これを ./device1/index.rst に書きましたが、うまくいきません。どうすれば親の rst ファイルをインポートできますか?

reStructuredText から生成された jQuery lightBox 実装を Web サイトで使用しようとしています。lightBox は、画像の周りのリンクのタイトルを lightBox ディスプレイの画像のキャプションとして受け取ります。

しかし、reStructuredText でリンクにタイトル属性を提供する方法が見つからないようです。これを行う方法を知っている人はいますか? 私の画像は次のように定義されています：

したがって、alt属性は追加できますが、タイトルは追加できません。可能な代替手段は、次のようにターゲットを参照として使用することです。

この後者の場合、下部に定義されたリンクに属性を追加する方法がわかりません (可能な場合)。

Sphinxを使用してPythonプロジェクトのドキュメントを自動的に生成しようとしています。モジュールの1つにscipy.signalパッケージが必要です。これは、次を使用してインポートしようとしています。scipy.signalをsignalとしてインポートします。コードは問題なく実行されますが、Sphinxでhtmlを作成すると、セグメンテーション違反が発生します（以下の出力）。ただし、「import scipy as sp」を使用して、sys.pathにscipyディレクトリを配置すると、ドキュメントが問題なく生成されますが、もちろん、コードにそのような機能はありません。必要。

問題を実証するために非常に単純なテストケースを作成し、いくつかのdocstringを使用してテストクラスを作成しました。私はそれを私の.rstと一緒に以下に含めています。「importscipy.signalassignal」という行をコメントアウトすると、すべてが非常にうまく機能します。

scipy.signalをインポートしながら、segの障害を回避する方法についての洞察に感謝します。ローレン

Sphinx出力：

pyexample.py

index.rst

docstrings.rst

私は熱心なライターのグループの一員であり、あるプログラミング言語のクックブック スタイルの本を共同で作成することを決めました。

コラボレーションのパイプラインを選択しようとしています。

ProGitの作り方が気に入っています。

これは Markdown + Pandoc によって処理されたカスタム前処理です。しかし、Markdown は私たちの場合には単純すぎるのではないかと心配しています。

Sphinxを見ていますが、使用した経験はありません。

LaTeX が機能することはわかっていますが、貢献者を怖がらせてしまうのではないかと心配しています。また、ビザンチン パイプラインを構築するのは、必要な経験がなければ (私にはありませんが) 強力すぎるかもしれませんし、簡単すぎるかもしれません。

手動で XML を記述しなければならない、または特定のGUI を使用しなければならないようなソリューションを提案しないでください(もちろん、オプションで利用可能な GUI は有効です)。商用および非クロスプラットフォーム ソリューションもオプションではありません。

Sphinxを使用してコードベースの基本的なドキュメントを自動生成しようとしています。ただし、ファイルを再帰的にスキャンするようにSphinxに指示するのが困難です。

次のようなフォルダ構造を持つPythonコードベースがあります。

でsphinx-quickstartを実行した<workspace>ので、構造は次のようになります。

クイックスタートチュートリアルを読みましたが、まだドキュメントを理解しようとしていますが、その言い回しでは、コードベース内のすべてのモジュール/クラス/関数のドキュメントファイルを手動で作成することをSphinxが想定しているのではないかと心配しています。 。

ただし、「automodule」ステートメントに気づき、クイックスタート中にautodocを有効にしたので、ほとんどのドキュメントが自動的に生成されることを期待しています。conf.pyを変更してsrcフォルダーをsys.pathに追加してから、index.rstを変更してautomoduleを使用しました。これで、私のindex.rstは次のようになります。

サブパッケージで定義されたクラスと関数は数十あります。しかし、私が実行すると：

それは報告します：

そして、これは私のパッケージ内に何かをインポートできなかったようです。生成されたindex.htmlを表示すると、「Contents：」の横に何も表示されません。インデックスページには「mypackage（モジュール）」のみが表示されますが、クリックすると内容が表示されません。

すべてのクラスを自分で手動でリストすることなく、パッケージを再帰的に解析し、検出したすべてのクラス/メソッド/関数のドキュメントを自動的に生成するようにSphinxに指示するにはどうすればよいですか？