Consider moving to MkDocs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- markdown
調査の方向性
現在の Sphinx 設定と既存の Markdown および reST ドキュメントを確認し、そのうえでカスタム拡張機能を MkDocs およびその Material テーマと比較します。既存の Lychee リンクチェック設定と、段階的な Markdown 変換の実現可能性を確認します。この issue にはファイル名も受け入れ基準も記載されていないため、合意済みの移行範囲と完了の定義を引き続き決める必要があります。
索引モデルが issue の本文から書いたものです。
説明
Just an idea. Pros:
- Simpler stack, simpler config.
- Markdown has won. People don't know reST, even myself, after years of using it, still make the most basic mistakes and need to lookup the most basic stuff.
- Also supported by RTD.
- Has the Material theme, which is modern, under active development, flexible, has dark theme, etc.
- Is used at other projects, such as python.cz or junior.guru, so know-how would be shared (contributions, maintenance).
Cons:
- We extend Sphinx and would need to rewrite those things.
- We use reST extensively. I'm not sure we can port it 1:1 (but is it necessary?)
How:
- This can happen gradually. Our current setup supports Markdown, so texts can be converted first and we would see.
- I already moved from builtin Sphinx link check to Lychee, as it works better.
- 主要言語
- Python
- スター
- 13
- フォーク
- 18
- 平均マージ
- 1時間 43分
- マージ済み PR（30日）
- 7
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pyvec/docs.pyvec.org のほかの issue
-
Info o PayPal a Wiseオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
pyvec/docs.pyvec.org#537 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
pyvec/docs.pyvec.org#30 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
pyvec/docs.pyvec.org#538 ·
-
broken links
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
pyvec/docs.pyvec.org#516 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
pyvec/docs.pyvec.org#482 ·
pyvec/docs.pyvec.org の issue をすべて見る
似ている issue
-
changelog investigate
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
ramnes/notion-sdk-py#409 ·
-
good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
lindicaphxag-tech/kaggle#28 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
BSData/horus-heresy-3rd-edition#3211 ·
メンテナーはふだん 1 日以内に返信
-
bug needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
bug tests
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信