Migrate astropy.org to be hosted RTD

Open
#697 12 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Read the Cycle 5 proposal at finance/proposal-calls/cycle5/aperio-documentation.md and inspect the current astropy.org build while the Sphinx migration is in progress. Define the hosting and migration scope, then verify that the site is hosted on RTD and available to the unified search through the RTD search API.

Written by the indexing model from the issue text.

Description

Feature Request

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)

Dominant language
Python
Stars
47
Forks
107
Avg merge
1d 6h
Merged PRs (30d)
5

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from astropy/astropy.github.com

All issues in astropy/astropy.github.com

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.