S³ School 2026 - Secure & Deploy - Documenting - Alexander Moreno Briceño скачать в хорошем качестве

S³ School 2026 - Secure & Deploy - Documenting - Alexander Moreno Briceño

📚 In this lecture, you learn how to build real documentation for scientific software with Sphinx: generate API docs from docstrings, write user guides/tutorials, include Jupyter notebooks, and publish everything automatically online with CI/CD (GitHub Actions → GitHub Pages). What you’ll learn : Why documentation is essential for sustainable & reproducible research software The 3 layers of documentation: API reference, user docs, tutorials Sphinx workflow: sphinx-quickstart, themes (ReadTheDocs), extensions (autodoc, napoleon…) Building docs from docstrings + .rst / Markdown + Jupyter notebooks (nbsphinx) Automating builds & deployment with a GitHub Actions workflow (docs → GitHub Pages) 🔗 Slides & materials (this session) Course page (S3 2026 Lectures): https://s3-school.github.io/s3-2026-l... School resources All lectures & materials : https://s3-school.github.io/s3-2026-l... GitHub organization : https://github.com/s3-school Indico event page : https://indico.in2p3.fr/event/36319/ Tags S3 School,S3 School 2026,Sustainable Scientific Software,Research Software,Research Software Engineering,RSE,Documentation,Sphinx,ReadTheDocs,sphinx_rtd_theme,Docstrings,API documentation,autodoc,napoleon,reStructuredText,rst,Markdown,nbsphinx,Jupyter notebooks,Tutorials,User guide,CI/CD,GitHub Actions,GitHub Pages,Continuous Integration,Python,Pixi,Reproducible research,Open Science,Software sustainability,Scientific software If this helped, please like, subscribe, and check the slides/materials link above. 🔔