Making Your Documentation Interactive with PyScript PyCon
Jeff Glass presented "Make Your Documentation Interactive with PyScript" at PyCon US, focusing on enhancing documentation interactivity. Attendees can access slides, demos, and resources for further exploration.
Read original article
On May 17, 2024, Jeff Glass presented a talk titled "Make Your Documentation Interactive with PyScript" at PyCon US in Pittsburgh. The presentation focused on enhancing documentation interactivity using PyScript, a framework that allows Python code to run in web browsers. Attendees can access all related materials, including slides, supporting details, links, repositories, and live demos. The demos are hosted in separate repositories to maintain clarity, featuring a generic HTML documentation site for static hosting, a site utilizing `mkdocs-pyscript` on GitHub Pages, and another built with `sphinx-script` on Read the Docs. Additional resources include the PyScript home page, the PyScript repository, and extensions like mkdocs-pyscript and sphinx-pyscript, which facilitate the integration of executable code editors into documentation. The PyScript Discord serves as a community hub for troubleshooting and communication among users and developers. The content is available for further exploration, and the slides can be viewed on Google Slides.
Related
Docs as code (2017)
Documentation as Code (Docs as Code) aligns documentation creation with coding practices, emphasizing collaboration, integration with development, and tool consistency. Write the Docs community advocates this approach through talks, successful industry examples, recommended books, and an open-source toolchain for effective implementation.
Let's Treat Docs Like Code
Treating documentation like code involves using tools like GitHub, automation, and static site generators. Importance of learning these tools, best practices for efficient writing, protecting branches, case studies, and resources are discussed. Insights on building documentation sites are provided.
Beyond Hypermodern: Python is easy now
Python development in 2024 focuses on simplicity with tools like Rye aligning with packaging standards. It streamlines setup, dependency management, and project structuring, emphasizing typing with Pyright for efficient code maintenance and pytest for testing.
Why I Prefer RST to Markdown
The author prefers reStructured Text (rST) over Markdown for technical documentation, citing its complex structure, custom directives, and better management of content across formats, despite its less attractive syntax.
SimPy is a process-based discrete-event simulation framework in Python
SimPy is a Python framework for discrete-event simulation, modeling active components and shared resources. It supports various simulation speeds and includes extensive documentation, tutorials, and community resources. The current version is 4.1.1.
0 commentsRelated
Docs as code (2017)
Documentation as Code (Docs as Code) aligns documentation creation with coding practices, emphasizing collaboration, integration with development, and tool consistency. Write the Docs community advocates this approach through talks, successful industry examples, recommended books, and an open-source toolchain for effective implementation.
Let's Treat Docs Like Code
Treating documentation like code involves using tools like GitHub, automation, and static site generators. Importance of learning these tools, best practices for efficient writing, protecting branches, case studies, and resources are discussed. Insights on building documentation sites are provided.
Beyond Hypermodern: Python is easy now
Python development in 2024 focuses on simplicity with tools like Rye aligning with packaging standards. It streamlines setup, dependency management, and project structuring, emphasizing typing with Pyright for efficient code maintenance and pytest for testing.
Why I Prefer RST to Markdown
The author prefers reStructured Text (rST) over Markdown for technical documentation, citing its complex structure, custom directives, and better management of content across formats, despite its less attractive syntax.
SimPy is a process-based discrete-event simulation framework in Python
SimPy is a Python framework for discrete-event simulation, modeling active components and shared resources. It supports various simulation speeds and includes extensive documentation, tutorials, and community resources. The current version is 4.1.1.