Rewrite to a sphinx project and use unified theme#698
Rewrite to a sphinx project and use unified theme#698Cadair wants to merge 21 commits intoastropy:mainfrom
Conversation
4b2fc98 to
af49c3f
Compare
|
I'll keep a list of things I think we could tidy up here as I go along:
|
d351274 to
d4640ba
Compare
This comment was marked as outdated.
This comment was marked as outdated.
|
You will have to pull this change in too after it is merged. FYI |
|
@astropy/astropy-website-maintainers This is now ready for review. |
| sphinx | ||
| myst-parser | ||
| sphinx-design | ||
| astropy-sphinx-theme@git+https://github.com/Cadair/astropy-sphinx-theme@sunpy-astropy-theme |
There was a problem hiding this comment.
We should probably cut a release of astropy-sphinx-theme before merging this PR 😉
There was a problem hiding this comment.
Can you pls cross link PR from that branch here for future reference? Thanks!
There was a problem hiding this comment.
It's in the PR description above.
There was a problem hiding this comment.
Oh right, nevermind. We cannot merge until this is resolved. I better block merge given the approval.
Shouldn't I wait for you to resolve #698 (comment) first? |
No, I don't think so. This PR is not about the theme it's about rewriting the astropy.org site to use sphinx. Comments about the theme should go on the theme PR. |
|
Now for the record: I'm not a maintainer of this repro because I have deep experience with web development, it's because we used to manually update the list of affiliated packages in this repro and I was the affiliated package editor at the time (and are again now, though we know how've a difference mechanism). That said, I'll have a look as soon as I can. |
hamogu
left a comment
There was a problem hiding this comment.
Most of the changes are pretty straightforward changes for html->rst. I'm not saying that to diminish @Cadair 's work (I know it's still a lot of work to do that, but it's not conceptually hard), just to say that the review is basically "it works" and there is no need to review every changed line, because we would not want to include any changes in the wording of individual pages here anyway.
Otherwise, it's a pretty standard setup and I see no problems with it.
| // Quirk to note: the jQuery.getJSON function fails if you open this locally | ||
| // with Chrome, because Chrome thinks local JSON files are unsafe for some | ||
| // reason. Use basically any other modern browser, or it works fine if its | ||
| // actually on the web server even with chrome. |
There was a problem hiding this comment.
Not really important here, since this is just a comment anyway, but I think most modern browsers now refuse to load any local file for security - for testing locally you'll a local web server running for all or most of them.
There was a problem hiding this comment.
yeah this comment is pretty old 😆
I'd like to purge this entire file of js if I have the time.
|
You have to resolve conflict to pick up #699 . Thanks! |
|
Merged in main |
|
Hmm something is wrong.
|
|
Looks like that's a circleci problem, the way that circleci previews somethings doesn't really work properly. If you look at the RTD preview it seems to work. |
|
Thanks for the clarification. I hope you are right... |
|
So this is good to merge or are we waiting on something else? |
There was a problem hiding this comment.
Can you please add comment to explain what this is for, for future reference?
pllim
left a comment
There was a problem hiding this comment.
Also... Don't we also use some sort of banner mechanism here that "talks" with astropy cord RTD, like when we announced the 10k citation stuff. Would that still work?
| sphinx | ||
| myst-parser | ||
| sphinx-design | ||
| astropy-sphinx-theme@git+https://github.com/Cadair/astropy-sphinx-theme@sunpy-astropy-theme |
There was a problem hiding this comment.
Oh right, nevermind. We cannot merge until this is resolved. I better block merge given the approval.
There's a todo list in the OP, but mostly it's blocked on people reviewing / approving / arguing about colours on the theme PR. |
pllim
left a comment
There was a problem hiding this comment.
Waiting for sunpy theme release
Yes, but I should actually make this site display the banner if it's active! |
|
Oh the other reason this shouldn't be merged at the moment is that it would break astropy.org in its current state. We need to figure out how to do the RTD migration, which needs someone to make (adopt?) the RTD project with an official hat on, and then to know who has the DNS power. |
I have the power if CoCo7 let me.
You have to hunt down @eteq |
b122766 to
f18d04b
Compare
use intersphinx for references to docs.astropy.org
You can see a preview of this here: https://astropy-org--698.org.readthedocs.build/
Fun things to checkout:
I think this is now ready for review, but please confine review to the diff in this PR. i.e. not the theme which should be reviewed here: astropy/astropy-sphinx-theme#48
HTML Pages left to port:
Todo before merge:
Other potential improvements: