How pyopensci/python-packaging-guide works
Project type and purpose
• This is a static‐site documentation project (“pyOpenSci Python Packaging Guide”) built with Sphinx, orchestrated by nox.
• Purpose: provide multi‐language tutorials and best practices on Python packaging, with translation and CI workflows.
File structure
• Top‐level directories:
• documentation content: index.md, tutorials/, documentation/, package-structure-code/, tests/, continuous-integration/
• Sphinx config and sources: conf.py, _ext/ (custom Sphinx extensions), _templates/, _static/, bibliography.bib
• Examples: examples/
• Localization: locales/
• CI/build configs: noxfile.py, .github/workflows/, .circleci/config.yml, crowdin.yml
• Key patterns:
• Static Site Generation (SSG) via Sphinx
• Automated builds/test via nox and CI pipelines (GitHub Actions & CircleCI)
• Translation workflow via Crowdin
README for additional insights
• Build steps: use nox -s docs and nox -s docs-live to generate .nox env and HTML in _build/html
• Build modes: development builds all languages; production filters by release_languages
• CI workflows for building, testing, publishing
Detailed Capturing of Architectural Elements
• conf.py & _ext/ as the Sphinx engine’s plugin layer
• CI configs in .github/workflows/ and .circleci/config.yml invoking nox
• Environment variables (SPHINX_ENV) controlling build modes
• Live‐reload for local development vs. production artifact generation