Sphinx documentation: No backlink to the main project

オープン 初心者向け
#258 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
68/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
python
領域
documentation

調査の方向性

Python bindings の Sphinx ドキュメント設定、特にサイドバーの設定を調査し、生成されたページのレイアウトを確認してください。ドキュメントに https://precice.org/couple-your-code-api.html へのバックリンクが含まれ、そのリンクがサイドバーまたは同等のナビゲーションに表示されれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

In the Sphinx documentation, there is no backlink to the preCICE website. That would be useful for people landing directly to the Python bindings documentation from a search engine, for example.

I think that adding something in the sidebar, for example, would be good. It could link to https://precice.org/couple-your-code-api.html

Current view:

Image

Diverged from #239

主要言語
Cython
スター
30
フォーク
19
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

precice/python-bindings のほかの issue

precice/python-bindings の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。