Readthedocs not generating properly
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 58/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- docker
調査の方向性
docs/examples.rst の 10 行目と README.rst の 40 行目から始め、続いて Read the Docs のドキュメントビルドを再現して code-block の警告を調べます。両方の場所にあるディレクティブがドキュメント化された構文を満たしていることを確認し、これらの警告なしでビルドが完了したら作業完了とします。
索引モデルが issue の本文から書いたものです。
説明
Description
Problem with generating docs in readthedocs. Works locally and on github.
The problem seems to be the empty "..code-block::" directive.
/home/docs/checkouts/readthedocs.org/user_builds/eiffellib/checkouts/stable/docs/examples.rst:10: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
# From https://hub.docker.com/_/rabbitmq
docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
../README.rst:40: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
# From https://hub.docker.com/_/rabbitmq
docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
looking for now-outdated files... none found
Motivation
Readthedocs documentation should always work.
Exemplification
Benefits
Working documentation
Possible Drawbacks
none
- 主要言語
- Python
- スター
- 8
- フォーク
- 12
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
eiffel-community/eiffel-pythonlib のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
eiffel-community/eiffel-pythonlib#44 · コメント 1 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
eiffel-community/eiffel-pythonlib#31 · コメント 1 件 ·
-
on-hold
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
eiffel-community/eiffel-pythonlib#28 · コメント 3 件 ·
eiffel-community/eiffel-pythonlib の issue をすべて見る
似ている issue
-
[Bug]: `hermes plugins update` clones an entire monorepo twice - `subdir` is resolved but dropped at both catalog-update call sites対応中かも @HootRock が今日担当しました。 オープンcomp/cli P2 type/perf
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
NousResearch/hermes-agent#142417 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
bug enhancement python
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
DewaldOosthuizen/tech-cheat-sheets-and-notes#392 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
bug p2
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
Restore postgresql_vm_test_charm actions.yaml change (removed in canonical/postgresql-operator#2054)オープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
canonical/postgresql-single-kernel-library#390 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信