Open choldgraf opened 3 years ago
Also note - I'm going to prefix all of these issues with [MyST]
to help differentiate them from others, since I cannot add tags etc myself.
@jpmckinney do you prefer to have one mega-PR that does all of the changes at once, or is it OK to break this into several smaller PRs that get merged over time?
I've changed your role to Maintain, so you should be able to create/add labels. An issue prefix is also fine.
I have no preference in terms of PR size. For larger PRs, I sometimes read one commit diff at a time when reviewing.
Follow-up for this issue:
Small cleanup that can be done in later PRs:
sphinx-build -nW --keep-going -q -b dirhtml $(DOCS_DIR) $(BUILD_DIR)/en
once warnings are clearedAfter theme change, follow-up to replicate search features:
Hey @jpmckinney - I've updated the top comment with a few more of the to-dos that we discussed. I think that a lot of the eval-rst
blocks are converted, and I'm wondering what you'd prefer that we prioritize moving forward. E.g., do you prefer that we finish up the MyST conversion to 100%, or better to try out new themes etc?
I think better to try out new themes. And yes, I'll do the two search-related bullets :)
@jpmckinney we just released a new version of the PyData theme: https://github.com/pydata/pydata-sphinx-theme/releases
I think that this should make it a bit easier to customize and such. When trying out a new theme for these docs, would you like to try that (because it is a topbar-based theme) or start with the Sphinx Book Theme (https://sphinx-book-theme.readthedocs.io/) ?
My intuition is that if you'd like a top-bar for navigation eventually, then it will be easier to start with the PyData theme and customize, rather than start w/ the Book theme and add a top-bar. Strong preferences?
Thanks for the explanation and updates! Let's go with the PyData theme 👍
This is a meta-issue to track conversion of documentation syntax to use MyST Markdown. It may grow or shrink as more focused issues pop up during initial conversion so I'll track them here.
#1220, #1221,#1247)After this is mostly done
Note - Chris is not sure if the following are in scope for him or not...he suspects somebody else will be more efficient in doing it than he is