DOCS: Refactor demo docs #544
Conversation
choldgraf
force-pushed
the
DOC-refactor-docs
branch
from
7288416
to
82c73d3
Compare
|
This is going to go out-of-date as soon as we touch the demo docs again. Since this PR is purely documentation, if folks are OK with it I'd like to merge in the next day or two unless there are objections. I'm happy to iterate on this PR if there are comments, but if people don't have the time maybe we can just merge it in and make improvements from there? Note that this PR has already benefitted from a round of reviews from @jorisvandenbossche in #483 - I believe all of his concerns there are also addressed here |
|
OK - @damianavila the latest commit removes all of the "automated python downloading" stuff, and instead adds a section to our contributing guide to show people how to update the kitchen sink. If you're +1 on that, then I think we're ready to merge |
| text = Path("./warnings.txt").read_text().strip() | ||
| print("\n=== Sphinx Warnings ===\n\n" + text) # Print just for reference so we can look at the logs | ||
| unexpected = [ii for ii in text.split("\n") if "kitchen-sink" not in ii] | ||
| assert len(unexpected) == 0 |
There was a problem hiding this comment.
The reason for this manual check instead of -W is to not error on warnings in the kitchen sink pages? (since those are out of our control?)
There was a problem hiding this comment.
The manual check is because we know the kitchen sink has errors, and that is because we want to be able to demo what it looks like when an error is rendered into the actual page, since many of our users will do this. So we want to make sure that there are no "unexpected errors", which is what this check is for
| example_pandas | ||
| mult_headers | ||
| subpages/index | ||
| subpages2/index |
There was a problem hiding this comment.
For some reason I added two collapsible pages next to each other in #349 (the subpages2 in addition to subpages), but I don't remember if that had a practical reason for testing .. (I suppose we can always add it back when we discover something related to it)
|
woo - thanks @jorisvandenbossche :-) |
This one takes over from #483 , which got messed up due to a rebase. This does a few things:
demo.rstintokitchen-sink/, a collection of pages that are pulled from the sphinx-themes.org repository automatically.closes #461