問題タブ [read-the-docs]

私はプロプライエタリな社内アプリケーションを開発しており、どこかでドキュメントをビルドしてホストしたいと考えています。独自仕様であるため、readthedocs のパブリック バージョンは使用できません。http://readthedocs.orgの有料版または非公開版はありますか?

Sphinx を使用してプロジェクトの API ドキュメントをローカルで自動生成できますが、ReadTheDocs を使用しようとすると問題が発生します。ReadTheDocs がドキュメントを作成するとき、API ページはすべて空白です (たとえば、これを参照してください)。このブログ エントリを読んだ後、解決策は numpy や matplotlib などをモックすることであることに気付きました。だから私は次の行を私のconf.py

その追加により、次の 2 つの Sphinx の問題により、ローカルまたは ReadTheDocs で API ドキュメントをビルドできません。

問題＃1：

ドキュメントをビルドすると、次のエラーが発生します。

このエラーは、単純にmatplotlib.__version__.split("."). この問題をすぐに解決する方法がわからなかったので、コメントアウトしました。

問題＃2：

ドキュメントをビルドすると、次のエラーが表示されます。

問題のある行 ( ) をコメントアウトすると、モジュールが辞書 への割り当てでいっぱいに_mpl.rcParams['backend'] = 'Qt4Agg'なるため、次の行でも同じエラーが発生します。paramsmatplotlib.rcParams

これらの問題は両方とも、修正するのが面倒なようです。より良い方法はありますか？そうでない場合、問題 1 と 2 をどのように解決すればよいですか?

これを読むと、モックで辞書を使用するための回避策があるようです。から来る文字列と同じくらい基本的なものを使用するための同様のソリューションを検索する必要がありますmatplotlib.__version__か?

それが役立つ場合、github のコードはこちらです。

さまざまなフォルダーを含むディレクトリがあり、それぞれに matlab ソース ファイルが含まれています。これらのフォルダーの一部には、matlab ソース ファイルを含むサブフォルダーがあります。

Sphinx を使用して TOC ツリーを作成し、サブフォルダーをネストされた方法で含めるにはどうすればよいですか?

たとえば、次のフォルダ構造とともに、、およびMain-Directoryが含まれている場合:conf.pyindex.rstmoduleslist.rst

このindex.rstファイルで：

そしてこのmoduleslist.rstファイル：

ただし、これにはサブフォルダーFolder2.1とファイルは含まれません。のドキュメントが含まれていないのオートモジュールを含む を追加しようとしFolder2/indexました。index.rstFolder2/index.rstFolder2.1ghi.m

Sphinx の TOC ツリーにネストされたサブフォルダを表示するにはどうすればよいですか?

コンテナー化された readthedocs インストールを構築しました。これまでのところ満足していますが、プロジェクト ページに短い URL が作成されていることがわかります。残念ながら、短い URL は DNS に存在しないため、どこにもリンクしないでください。たとえば、次のように表示されます。<project>.readthedocs.mydomain.com

管理ポータルと rtd ドキュメントを調べても、それらがどこで構成されているかがわからず、shorturl を別の形式に変更する方法も、shorturl を無効にする方法も見つかりませんでした。他の誰かがこの問題を抱えていましたか?おそらく共有できる解決策がありますか?

どうもありがとう

構造

プロジェクトの次の構造:

• index.rst

  /li>

• group1.rst

  /li>

レンダリング先 ( Group1->をクリックした後Subgroup2):

ご覧のとおり、Group1ページが開き、セクションにリンクされていSubgroup2ます。

欲しい

左側（Group1opennedとselected Subgroup2）に同じものを置きたいのですが、右側にはSubgroup2ページ（Subgroup1コンテンツのないページ）のみを表示したいです。

つまり、ファイルがありますgroup1/subgroup1.rst：

レンダリング先:

それはどのように達成できますか？これは深さ 2 の簡単な例ですが、深さ 3 ～ 4 はどうでしょうか。

Sphinxを使用する場合、 TOC ディレクティブを使用して目次を編集 (要素の並べ替え、子ノードの使用など) できることを理解しています。

Markdown を使用するときにこれを達成することは可能ですか?

編集バッジは GitHub でも緑色で表示されるようになりました。GitHub によって行われるキャッシュに関連している可能性はありますか?

編集 2あ、また赤くなった。

ここの ReadTheDocs プロジェクトのバッジは緑色です。

しかし、バッジの HTML または Markdown コードをGitHub リポジトリの README.mdファイルに貼り付けると、常に赤く表示されます。

• バッジコードが正しいことを約20回確認しました。他の場所では緑色に表示されます (たとえば、バッジ コードをhttp://www.ctrlshift.net/project/markdowneditor/に貼り付けた場合)。
• また、別のインターネット ブラウザーと携帯電話から GitHub ページを開きましたが、まだ赤いので、クライアント側のキャッシュの問題ではありません。
• バッジの画像ソースに直接アクセスすると、緑色のバッジも表示されます。

一体何が間違っているのですか？

README.md