I'm opening this issue here to track the work for my Cycle 5 Proposal across the various packages in the Astropy ecosystem.
I won't duplicate the proposal document here, as that gives a high level overview of the work.
A personal plea: I don't have many hours for this project, so I'm trying to keep the scope tight. I'd really appreciate it if reviewers bear this in mind, if I spend all the time tweaking small things then this project wont get finished. (I'm 66% of the way through my time.)
Phase 1
Theme Development & Website
The first phase of this work is now mostly complete, this involved converting the astropy.org website into a sphinx project and adding the new theme to the astropy-sphinx-theme repo.
PRs for this work are now up for review, the following is the intended merge order, ones marked as draft are not ready for review but the others are now ready for review.
- astropy-sphinx-theme cleanup - Repo Cleanup astropy-sphinx-theme#47
The sphinx-theme repo had got a bit crufty so I gave it a clean up before extending it.
- (Postponed to later) astropy.org website - Migrate the current website to be hosted on RTD. Migrate (old site) to RTD astropy.github.com#701 - Needs someone with astropy.org DNS permissions
- astropy-sphinx-theme New astropy-unified theme added - Add New Astropy Theme astropy-sphinx-theme#48
This is the place to comment on the visuals of the theme and also astropy specific settings such as the content of the header and footer etc.
- (4a) astropy.org website - Rewrite to a sphinx project and use unified theme astropy.github.com#698
This PR is ready to review, all be it not merge (it needs the theme PR). When reviewing this PR theme comments should be left on the theme PR.
- (4b) sphinx-astropy - Add a new confv3 with astropy-unified theme sphinx-astropy#94
This PR adds a v3 config which enables the new theme, this can be merged independently of the website PR (as it does not use sphinx-astropy).
Phase 2
Roll out to all coordinated packages (and any others who want it).
- Core - Migrate documentation to new unified astropy sphinx theme astropy#19206
- reproject - Migrate to new astropy-unified theme reproject#581
- asdf-astropy - Update sphinx configuration to use new astropy-unified theme asdf-astropy#325
- astropy-healpix - Update sphinx configuration to use new astropy-unified theme astropy-healpix#304
- astroquery - Update sphinx configuration to use new astropy-unified theme astroquery#3590
- ccdproc - Update sphinx configuration to use new astropy-unified theme ccdproc#922
- photutils - Update sphinx configuration to use new astropy-unified theme photutils#2274
- regions - Update sphinx configuration to use new astropy-unified theme regions#664
- specreduce - Update sphinx configuration to use new astropy-unified theme specreduce#308
- specutils - Update sphinx configuration to use new astropy-unified theme specutils#1328
Other related things
I've opened an issue to discuss learn.astropy.org adopting this: astropy-learn/learn-astropy#140
I'm opening this issue here to track the work for my Cycle 5 Proposal across the various packages in the Astropy ecosystem.
I won't duplicate the proposal document here, as that gives a high level overview of the work.
A personal plea: I don't have many hours for this project, so I'm trying to keep the scope tight. I'd really appreciate it if reviewers bear this in mind, if I spend all the time tweaking small things then this project wont get finished. (I'm 66% of the way through my time.)
Phase 1
Theme Development & Website
The first phase of this work is now mostly complete, this involved converting the astropy.org website into a sphinx project and adding the new theme to the astropy-sphinx-theme repo.
PRs for this work are now up for review, the following is the intended merge order, ones marked as draft are not ready for review but the others are now ready for review.
The sphinx-theme repo had got a bit crufty so I gave it a clean up before extending it.
This is the place to comment on the visuals of the theme and also astropy specific settings such as the content of the header and footer etc.
This PR is ready to review, all be it not merge (it needs the theme PR). When reviewing this PR theme comments should be left on the theme PR.
This PR adds a v3 config which enables the new theme, this can be merged independently of the website PR (as it does not use sphinx-astropy).
Phase 2
Roll out to all coordinated packages (and any others who want it).
Other related things
I've opened an issue to discuss learn.astropy.org adopting this: astropy-learn/learn-astropy#140