PyCon APAC 2022｜一般演講 Talks｜國泰金控 Cathay Financial Holdings / 美光科技 Micron 冠名贊助 ✏️ 共筆 Note：https://hackmd.io/@pycontw/B1nqUTQ1s ?? Slido：https://app.sli.do/event/2odhKfnXyV33Y4yCPDsZdb ? 語言 Language：英文 English ? 層級 Level：中階 Intermediate ? 分類 Category：最佳實踐與慣例 Best Practices & Patterns ? 摘要 Abstract ? Developers have used Sphinx to integrate documentation into workflow and use tools and services to enhance the developer and user experience from those documentations. This talk will discuss how we further it by utilizing markup processors as extensions and generate more effective documentation. This will be also further elaborated on through a case study showcasing how integrating the documentation can improve the overall benefit towards a project and mistakes to avoid while attempting the integration. ? 說明 Description ? Documentation is often something developers find tedious and are not exactly enthusiastic about. However, it can be approached very differently; and with this talk, I will able to shed light on the exciting part of documentation with the creation of extensions; in particular over Sphinx. The benefits of Sphinx has been evident to many developers. It has helped in being able to create documentation for our services and put it in such a way that our users and fellow developers enjoy the experience. However, there is so much more to take away from Sphinx than is available from the functionalities that most developers utilize it for, and it all starts with defining our own extensions for it. This talk will discuss the best practices in creating markup processors as extensions for Sphinx and the benefits it provides users and developers in doing so. This will include how to plan, structure, and catch cases of errors that may come with the extension, as well as specific practices such as with documenting links, references, and in documenting considerations with extensions. This will also include highlighting the current trends in the development of extensions up to this point, and how hierarchy in documentations is being established and structured as a result of this. I will also mention some key points to consider, including making the documentation accessible and managing it as part of the code repository. At the end of the talk, I will demonstrate this by through a demonstration coupled with talking through a case study of how my own markup processor extension works with Sphinx with its purpose of documenting a custom class type and how I am able to derive benefits from it to better the experience of my users and fellow developers. Users will leave this talk feeling ready to put into practice making new extensions as discussed in this talk as part of their SDLC. ? 講者介紹 About Speaker - Renaldi Gondosubroto ? Renaldi Gondosubroto is the Founder and CEO of GReS Studio, a company that promotes the concept of the Internet of Things by creating solutions for problems around the community while utilizing the concept. Leading his team of individuals that share the same passion as him with the IoT concept, he leads his company with the vision of being able to have an interconnected world where both individuals and companies can share big data with one another. Starting from just a hobbyist of programming in different languages including Python from a very young age, he eventually decided to venture into working within the IoT technology sector when he created an innovation to help combat a problem all around us which everyone encounters in their daily lives: air pollution. Throughout his time leading his company, Renaldi enjoys sharing his experiences regarding practices and trends that he believes are of importance to develop and navigate through the technologies of today. #pycontw #pyconapac2022 #python #sphinx #workflow #documentation Follow “PyCon Taiwan” ⭐️ Official Website: https://tw.pycon.org ⭐️ Facebook: https://www.facebook.com/pycontw ⭐️ Instagram: https://www.instagram.com/pycontw ⭐️ Twitter: https://twitter.com/PyConTW ⭐️ LinkedIn: https://www.linkedin.com/company/pycontw ⭐️ Blogger: https://pycontw.blogspot.com ... https://www.youtube.com/watch?v=QDExDbvfDb8

Follow “PyCon Taiwan” ⭐️ Official Website: https://tw.pycon.org ⭐️ Facebook: https://www.facebook.com/pycontw ⭐️ Instagram: https://www.instagram.com/pycontw ⭐️ Twitter: https://twitter.com/PyConTW ⭐️ LinkedIn: https://www.linkedin.com/company/pycontw ⭐️ Blogger: https://pycontw.blogspot.com ... https://www.youtube.com/watch?v=RPcqO4ccyPI