Great talk! I feel that I am not alone in forcing everyone to doc everything) And now I know the workflow that can be implemented more smoothly! Thanks!
I really enjoyed your talk. I'm a Tech Writer (now mostly a coding Tech Writer) and I'm more than happy to see that an engineer talks about docs with such enthusiasm. Great job!
Totally recommended talk. Mason gives a very complete and entertaining presentation. Perfect timing as I was just given the task to propose a way to improve our very defficient code documentation. I only wish you had gone a little deeper on the pydoc path, which I am (was?) planning to use. Thanks!
PyDoc and Sphinx go GREAT together. There actually was another talk at PyCon this year that goes over this in detail th-cam.com/video/CUjCqOw_oFk/w-d-xo.html
We use mkdocs extensively in my organisation for documentation and some of our pages are huge - around ~10000 lines of markdown over a period of time. The gh-deploy command sometimes doesn't update the github pages correctly until I do a git pull which has a forced update and then do a mkdocs gh-deploy manually. This occur on pages which has child elements and is denoted by and collapse/expand [+] button by mkdocs. @Mason - Have you faced this issue?
Great talk! I feel that I am not alone in forcing everyone to doc everything) And now I know the workflow that can be implemented more smoothly! Thanks!
Glad you enjoyed it!
I really enjoyed your talk. I'm a Tech Writer (now mostly a coding Tech Writer) and I'm more than happy to see that an engineer talks about docs with such enthusiasm. Great job!
Totally recommended talk. Mason gives a very complete and entertaining presentation. Perfect timing as I was just given the task to propose a way to improve our very defficient code documentation. I only wish you had gone a little deeper on the pydoc path, which I am (was?) planning to use. Thanks!
PyDoc and Sphinx go GREAT together. There actually was another talk at PyCon this year that goes over this in detail th-cam.com/video/CUjCqOw_oFk/w-d-xo.html
Fantastic talk! Going to look into incorporating mkdocs into my project.
Thank you!
Such a great talk, thank you Mason! It's the first PyCon 2020 talk that really wants me to change my workflow. :)
I agree, doctests are criminally underused.
We use mkdocs extensively in my organisation for documentation and some of our pages are huge - around ~10000 lines of markdown over a period of time. The gh-deploy command sometimes doesn't update the github pages correctly until I do a git pull which has a forced update and then do a mkdocs gh-deploy manually. This occur on pages which has child elements and is denoted by and collapse/expand [+] button by mkdocs. @Mason - Have you faced this issue?