2017-05-25 7 views
0

GitHubでホストされているCソースファイルまたはOS構成ファイルへのハイパーリンクを提供するreStructuredTextドキュメントを作成します。ドキュメントと同じレポ。リンクは、GitHub(同じリポジトリ内のファイルを指し示している)とDocsを読む(GitHubを指しているのが望ましい)の両方でリンクする必要があります。例えばreStructuredText GitHubで作業中のソースファイル(C、設定、...)へのハイパーリンク

:GitHubの上で期待通り

Source file link `main.c </src/main.c>`_. 

は、このファイルは動作しますが、それはドキュメントを読んでどこも指していません。

絶対リンクは正しく動作しますが、repoアドレスが変更された場合、または別のブランチが使用されている場合は、リンクを1つずつ変更する必要があるため実用的ではありません。便利

Source file link `mani.c <https://github.com/Me/MyRepo/blob/master/src/main.c>`_. 

何かが:source:を使用してhereを述べているが、私はそれが読むドキュメント上で動作するように取得する方法がわかりません。私のテストに基づいて、GitHubではうまくいきませんでした。

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

編集:

私は例のGitHub上のコードおよびそれから作成Read the Docsページを追加しました。

+0

[GitHub](https://github.com/jeras/readthedocs-source-links)と[Read the Docs]ページ(http:// read-the-docs-issue-with -source-links-demo.readthedocs.io/en/latest/)を作成します。 –

答えて

0

相対リンクを試してください(例:main.c <src/main.c> _)。

+0

私は試したが、うまくいかない。しかし、試してみるだけでは十分ではありません。実際には理にかなっているはずです。 –

関連する問題