Skip to content

Commit fb01034

Browse files
Update docs/monthly-meeting/2024-02.md
Co-authored-by: Ezio Melotti <[email protected]>
1 parent f4da79c commit fb01034

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/monthly-meeting/2024-02.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,19 @@ Please take a second to read through it!
5454

5555
[Ezio] We should also figure out what to do about collapsible sections.
5656
[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.
6358

6459
[Ned] re. pages being too long, we might switch to having a page for each function
6560
[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.").
6670

6771
- [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)
6872

0 commit comments

Comments
 (0)