astropy / astropy/astropy.github.com

Migrate astropy.org to be hosted RTD

オープン
#697 コメント 12 件 リアクション 1 件 担当者 0 名 GitHub で見る
Feature Request
主要言語
Python
スター
47
フォーク
107
平均マージ
1日 6時間
マージ済み PR(30日)
5

説明

This is a early warning / heads up issue.

As part of my Cycle 5 proposal to improve the unification of the astropy docs (https://github.com/astropy/astropy-project/blob/b04f81d10e268f700b4d6b9fe1fac5811daf155b/finance/proposal-calls/cycle5/aperio-documentation.md) it would be helpful to migrate astropy.org to be hosted on RTD.

The main motivation for this is that it allows the site to be indexed by the RTD server side search and to access that API without any tickery. This allows the unified search to work across the various projects *and* the homepage.

(It should also be noted that I'm in the process of migrating the site to be built with sphinx to enable all this as well)

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

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

調査の方向性

finance/proposal-calls/cycle5/aperio-documentation.md の Cycle 5 提案を読み、Sphinx の移行が進行中の astropy.org の現在のビルドを調査してください。ホスティングと移行の範囲を定義し、そのうえでサイトが RTD でホストされ、RTD search API を通じて統合検索から利用できることを確認してください。

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

評価

技術スタック
python
領域
documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
静か
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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