問題タブ [toctree]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
1 に答える
141 参照

python-sphinx - モジュールではなく toctree でパッケージを選択する

リポジトリ用のドキュメントを生成するために Sphinx を使用しています。Sphinxtoctreeを使用すると、:glob:特定のドキュメントを自動選択できます。

私はフォームのtoctreeを持っています

最初*は にあるさまざまなモジュールをすべて取得し、/some/repository/structureで始まるモジュールからすべてのドキュメントが必要ですacme_corp_

ただし、これは toctree が出力するときにパッケージとモジュールの両方を取得します。私は使用してみまし_generated/some/repository/structure/*/doc/acme_corp_*packageたが、一致するリンクを出力しません(単語packageが実際にはパスに表示されないと思うため)。

maxdepth: 1 toctree結果の目次でパッケージのみを取得するようにSphinxに自動生成させるにはどうすればよいですか?

0 投票する
1 に答える
893 参照

python-sphinx - Sphinx RST は HTML 出力でサブページを展開します

HTML と Latex の両方の出力形式でレポートを生成するために、sphinx ドキュメンテーション システムを使用しています。したがって、すべての章を出現順に参照する toctree を含む読み取り index.rst がある階層構造を持っています。次に、章は、ヘッダーのみを持つ index.rst と、その章のすべてのセクションを含む toctree も含むフォルダーです。

例として、私の構造は次のようになります。

文字通り someChapter とその下のセクションを取得するため、これはラテックスで美しくレンダリングされますが、html ではそれらはすべて個別のページであり、クリックし続ける必要があるため、いくつかの小さなサブセクションではすぐに退屈になります。場合によっては、toctree にある同じページにサブページを表示し、サブページを作成しないように html ビルダーに指示する方法はありますか?

私はsinglehtmlについて知っていますが、それは単一のhtmlページ全体を構築します。多くの場合、異なる章は異なるページで優れていますが、セクションは同じページに簡単に配置できるため、部分的にやりたいと思います。

どんな助けでも大歓迎です。