Repository navigation
Migrate astropy.org to be hosted RTD #697
Description
Activity
But astropy.org itself would still work, right? If not, that is a huge headache.
Also... What about all the custom JS functions to scrape Affiliated packages?
But astropy.org itself would still work, right? If not, that is a huge headache.
Yes of course you can configure custom domains with RTD (docs.astropy.org for example also sunpy. org).
Also arbitary JS, CSS and html are all perfectly possible with sphinx.
Possible, okay, but will it be easy?
Yes it's easy, I'm already working on porting the website. The index page including the dynamic version number is done. You can also just include plain html pages in the output if you really want to.
Some of the other JS can probably be replaced with build-time processing (think team.json) etc
Can we leave technical issues and review till I have a functioning port?
I am thinking more of this
astropy.github.com/affiliated/index.html
Line 398 in ed29abb
I haven't done that page yet, but it'll be fine.
Reacted by P. L. LimRTD is up (https://astropy-org.readthedocs.io/en/latest/). DNS change is @eteq
Reacted by Stuart MumfordSo after #696 caused issues elsewhere, I've done a little more research on the github pages setup.
I think the main hurdle to overcome here is how we keep some
astropy.org/<repo-name>URLs working where those repos want to be served from github pages and migrate astropy.org itself to RTD. data.astropy.org is one problematic case, but there may be others.It's possible on RTD to add redirects so we could add redirects to the
/<repo-name>to either a plain github.io address or a specific subdomain configured for those repos to keep the/<repo-name>working.We could also choose to deploy the new theme to the GHP site as in interim solution even though it will mean the unified search can't search astropy.org (i.e. you could search all the docs from astropy.org but not astropy.org from the docs or astropy.org itself).
Reacted by P. L. LimCan this be closed now?
No, it's still not hosted on RTD.
Reacted by P. L. Lim
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)