Image duplication for sphinx docs required

オープン
#161 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞

調査の方向性

まず README.md 内の画像パスと docs/ 配下のファイルを比較し、次に docs フォルダーから make html を実行して欠落している画像を再現します。Sphinx ドキュメントの設定を調査し、画像の重複コピーを避けるパス構成または検索設定を選択します。完了の条件は、GitHub README とローカルで生成されたドキュメントまたはオンラインのドキュメントの両方で画像が正しく表示されることです。

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

説明

bug documentation

Issue

Problem Description

Right now, the images in the readme.md have to also be in the docs folder for the paths to be solved correctly when generating the docs with sphinx.

Expected Behavior

One copy of the images should be fine.

What Needs to be Done

Find some way to make sphinx search the repo root not only the docs folder. or alternative find mutually compatible path where to store the images.

How Can It Be Tested or Reproduced

Look at readme on github and docs online or locally via make html in the docs folder.

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

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

aidotse/PASEOS のほかの issue

aidotse/PASEOS の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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