問題タブ [read-the-docs]

Sphinx で _template overrides オプションを使用して、 http://readthedocs.orgで Sphinx ドキュメントをホストするためのデフォルトの ReadTheDocs テーマをオーバーライドする方法を見つけようとしています。

具体的には、このテーマの右上隅に表示されている「Github で編集」リンクを削除/非表示にしたいと考えています。

どんなヒントでも大歓迎です！ありがとう！

http://www.sphinx-doc.org/en/stable/templating.htmlのドキュメントを確認しましたが、困惑しており、本当に助けが必要です。

ありがとうございました！

Doxygen と Markdown を併用して、中規模の C++ ソフトウェアのドキュメントを作成しました。xmlレイヤーを変更した後、私はそのようなものになってしまったので、私はそれにとても満足しています: http://docs.mitk.org/nightly/index.html

理想的には、ReadtheDocs のようなものを使用して、このドキュメントをオンラインにしたいと考えています。このドキュメントは、「git コミット」後に自動的にビルドされ、参照できるようにホストされます。

ReadtheDocs は理想的なサイトのように見えますが、Sphinx と reStructuredText をデフォルトとして使用しています。Doxygenも使用できますが、AFAIKはBreatheを介してのみ使用できます. そのルートをたどると、基本的に、すべての API ドキュメントを 1 つのページにまとめたくない場合は、すべてのドキュメントを再構成する必要があることを意味します ( http://librelist.com/browser//breathe/2011/8 /6/fwd-guidance-for-usage-breathe-with-existing-doxygen-set-up-on-a-large-project/#cab3f36b1e4bb2294e2507acad71775f )。

逆説的に、Doxygen は read-the-docs サーバーにインストールされていますが、苦労した結果、Sphinx または Mkdocs をスキップする回避策を見つけることができませんでした。

readthedocs.orgを使用して、プロジェクトのドキュメント (autodoc で自動生成されたドキュメントを含む) を生成したいと考えています。ただし、私のプロジェクトは Python 3.5 構文 ( asyncand await) を使用しており、それを処理できるようには見えません。次のような多くのエラーが発生しますが、ビルドは成功します。

これを修正する方法はありますか？

私の Sphinx ベースのドキュメントには、カスタムの Jinja2 テンプレートを含む特別なページがあります。このテンプレートのコンテキストとして、少しの Python コードで生成されたカスタム オブジェクトを渡したいと思います。(彼らはdatetime、一種のカレンダーです。) には、次のconf.pyようなものが含まれます。

これはローカルでは問題なくビルドされますが、Read the Docs は JSON を使用してシリアル化しようとします。「非 JSON 対応」オブジェクトをテンプレートに渡す方法はありますか?

私が得る例外は次のとおりです。

現在、read-the-docs を介して自分のコードのドキュメントをオンラインで取得しようとしていますが、read-the-docs を取得して PyQt4 依存モジュールを処理するには問題があるようです。

私のプロジェクトの構造は次のとおりです。

私は sphinx-autodoc を使用して、さまざまなモジュールの docstring の html 表現を作成しています。私のローカル マシンではすべて正常に動作しますが、ドキュメントを読むには PyQt4 が必要なので 、mock次の問題に遭遇しました: 私の GUI クラスの 1 つで、QtGui.QDialog

そしてlistSelectorDialog経由

嘲笑QtGuiすると、ドキュメントを読んで次のように言われます。

したがって、クラッシュします。[Install your project inside a virtualenv using setup.py install] を選択してパッケージを仮想環境にビルドしようとしましたが 、PyQt4 が にリストされていてもpipインストールできません。https://superuser を参照してください。 com/questions/679298/how-to-install-pyqt4-and-what-are-the-practical-differences-between-pyqt4-and-py .

これまでに見つけた唯一の回避策は、環境が RTD の場合に GUI モジュールをロードせず、GUI モジュールのドキュメントを除外することですが、これは最終的な解決策ではありません。ありがとう。

独自の readthedocs インスタンスを設定することを検討しています。Git、Mercurial、Subversion、および CVS をサポートしていることがわかります。ただし、TFVS を使用して TFS に座っている git に移行するのにかなりの労力を費やしているレガシー プロジェクトがいくつかあります。

彼らが話している webhook メソッドを使用して、これらのプロジェクトを引き込むことはまだ可能でしょうか?

これを機能させるためのコードベースのアプローチは何でしょうか?

最終的には、これらすべてを Github で公開したいと考えていますが、それはまだ販売する必要があるものです。