DOC: first pass at switching to pydata theme #19731
Conversation
|
Did you ever get this to build? |
|
It builds locally, I forgot to add the extra dependency to the requirements 🤦 . |
tacaswell
force-pushed
the
doc_use_pydata_theme
branch
from
519c81c
to
c3efc80
Compare
|
It at least builds! |
|
Nice... https://55478-1385122-gh.circle-artifacts.com/0/doc/build/html/index.html Obviously the front page is a mess, but we are replacing anyway. The rest definitely shows promise... |
|
Looks quite good. Some open style issues:
|
tacaswell
force-pushed
the
doc_use_pydata_theme
branch
from
c3efc80
to
3531493
Compare
tacaswell
force-pushed
the
doc_use_pydata_theme
branch
from
742388b
to
d4ec50a
Compare
|
Made more progress! Figured out that we were fully shadowing core style sheet which is why so many things looked broken. I have addressed the issues from @timhoffm above. It bulids clean locally, |
|
If this is clean and good enough, can we merge this quickly and iterate? |
There needs to be a bit more work on that, but yes. |
doc/conf.py
Outdated
| # html_logo = 'logo.png' | ||
| html_logo = "_static/logo2.svg" | ||
| html_theme_options = { | ||
| "logo_link": "/stable/index.html", |
There was a problem hiding this comment.
Is that what we want on versioned pages?
There was a problem hiding this comment.
Probably not. This also makes the locally built version of the docs not self-contained (so does the third party page link, but that includes the full URL so it atleast works (assuming you have network). I'll change this.
doc/conf.py
Outdated
| @@ -24,16 +24,16 @@ | |||
| # If your extensions are in another directory, add it here. If the directory | |||
| # is relative to the documentation root, use os.path.abspath to make it | |||
| # absolute, like shown here. | |||
| sys.path.append(os.path.abspath('.')) | |||
There was a problem hiding this comment.
There's a lot of unnecessary churn here; you really should configure black/pre-commit/whatever to only work on the diff you actually touched.
There was a problem hiding this comment.
I'll strip out the churn.
| license.rst | ||
| ../citing.rst | ||
| ../resources/index.rst |
There was a problem hiding this comment.
maybe, but that would change the URLs.
tacaswell
force-pushed
the
doc_use_pydata_theme
branch
2 times, most recently
from
ef82c2d
to
e4e4919
Compare
|
At this point, I do not think my struggles to get this working are of interest to anyone so squashed. |
tacaswell
force-pushed
the
doc_use_pydata_theme
branch
from
e4e4919
to
905a8d5
Compare
|
Given the two approvals I pushed the button on this! |
|
We thought to try reverting this to see if the doc build would actually speed up, but Github cannot revert it "the content may have changed since it was merged." so if we try to revert, it'll be manual. |
|
Um, can‘t you simply brach from an old commit? It‘s not exactly the same repo state and docs then, but I suppose that shouldn’t make the difference. |
PR Summary
Still super busted.Builds clean and looks mostly OK!