You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/monthly-meeting/2024-02.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,15 +54,19 @@ Please take a second to read through it!
54
54
55
55
[Ezio] We should also figure out what to do about collapsible sections.
56
56
[Ned] What problem are collapsible sections solving? Do we have too many examples that users will want to ignore? (In my docs I use tabs, but not collapsible sections)
57
-
[Ezio] If we agree to add basic examples inline, but bigger examples on the bottom, we won't need collapsible sections.
58
-
[Carol] So: yes examples, yes inline. We can pause discussions about collapsible sections; if the examples get too long we should think about spinning them out into their own howto pages. **Consensus Recap**
59
-
[Ezio] We could create a custom Sphinx directive that creates a link to the "Examples" section too. It should be unobtrusive and recognizable (it could have an icon, and a short text like "See more examples.").
60
-
61
-
[Ezio] Would it make sense to do different things based on the builder, e.g. collapsible sections for HTML and something else for PDF?
62
-
[CAM] Yes. Some current directives for collapsible sections do that.
57
+
[Ezio] They allow us to to add more examples inline without making the page too long and more difficult to navigate, but they don't work with non-HTML builders.
63
58
64
59
[Ned] re. pages being too long, we might switch to having a page for each function
65
60
[Carol] we could run a cron job to count lines
61
+
[Ezio] if we count code lines we can determine pages with not enough and too many examples
62
+
63
+
[Ezio] Would it make sense to do different things based on the builder, e.g. collapsible sections for HTML and something else for PDF?
64
+
[CAM] Yes. Some current directives for collapsible sections do that.
65
+
66
+
[Ezio] If we agree to add basic examples inline, but bigger examples on the bottom, we won't need collapsible sections.
67
+
68
+
[Carol] So: yes examples, yes inline. We can pause discussions about collapsible sections; if the examples get too long we should think about spinning them out into their own howto pages. **Consensus Recap**
69
+
[Ezio] We could also create a custom Sphinx directive that creates a link to the "Examples" section. It should be unobtrusive and recognizable (it could have an icon, and a short text like "See more examples.").
66
70
67
71
-[Hugo] Hosting docs on Read the Docs [python/docs-community#5 (comment)](https://github.com/python/docs-community/issues/5#issuecomment-1900698294) (Manuel Kaufmann, Ee, Julien were supportive)
0 commit comments