# sphinx

Published articles for sphinx.

This is one page of public article previews, not the complete archive. Follow Next page to continue. Summaries are not the original full articles.

## Sphinx + Bazel: the good, the bad, and the ugly

DevFeed: [Sphinx + Bazel: the good, the bad, and the ugly](<https://devfeed.tech/articles/sphinx-bazel-the-good-the-bad-and-the-ugly-31141.md>)

Original publisher: [Read original article](<https://technicalwriting.dev/2025/03/context/index.html>)

Published: 2025-03-25T00:00:00Z

Content type: opinion

Language: en

Sources: [technicalwriting.dev](<https://devfeed.tech/sources/technicalwriting-dev.md>)

Topics: [bazel](<https://devfeed.tech/topics/bazel.md>), [Documentation](<https://devfeed.tech/topics/documentation.md>), [Software Engineering](<https://devfeed.tech/topics/software-engineering.md>), [Development](<https://devfeed.tech/topics/development.md>)

Tags: [bazel](<https://devfeed.tech/tags/bazel.md>), [build-system](<https://devfeed.tech/tags/build-system.md>), [documentation](<https://devfeed.tech/tags/documentation.md>), [shell-script](<https://devfeed.tech/tags/shell-script.md>), [software-engineering](<https://devfeed.tech/tags/software-engineering.md>), [sphinx](<https://devfeed.tech/tags/sphinx.md>)

### AI overview

An experienced technical writer discusses the strengths and weaknesses of managing Sphinx documentation projects with Bazel. The article explains how Bazel can orchestrate Sphinx workflows and describes reported maintenance and development-environment benefits, while helping readers decide whether it fits their project.

### Source excerpt

Strengths and weaknesses of orchestrating Sphinx projects with Bazel.

## Orchestrate Sphinx projects with Bazel

DevFeed: [Orchestrate Sphinx projects with Bazel](<https://devfeed.tech/articles/orchestrate-sphinx-projects-with-bazel-31142.md>)

Original publisher: [Read original article](<https://technicalwriting.dev/2025/03/tutorial/index.html>)

Published: 2025-03-25T00:00:00Z

Content type: tutorial

Language: en

Sources: [technicalwriting.dev](<https://devfeed.tech/sources/technicalwriting-dev.md>)

Topics: [bazel](<https://devfeed.tech/topics/bazel.md>), [Tutorial](<https://devfeed.tech/topics/tutorial.md>), [Documentation](<https://devfeed.tech/topics/documentation.md>), [GitHub](<https://devfeed.tech/topics/github.md>), [GitHub Pages](<https://devfeed.tech/topics/github-pages.md>), [Bash](<https://devfeed.tech/topics/bash.md>), [Linux](<https://devfeed.tech/topics/linux.md>), [Extension](<https://devfeed.tech/topics/extension.md>), [Template](<https://devfeed.tech/topics/template.md>)

Tags: [bash](<https://devfeed.tech/tags/bash.md>), [bazel](<https://devfeed.tech/tags/bazel.md>), [build-system](<https://devfeed.tech/tags/build-system.md>), [docs](<https://devfeed.tech/tags/docs.md>), [extension](<https://devfeed.tech/tags/extension.md>), [github](<https://devfeed.tech/tags/github.md>), [github-pages](<https://devfeed.tech/tags/github-pages.md>), [linux](<https://devfeed.tech/tags/linux.md>), [repository](<https://devfeed.tech/tags/repository.md>), [sphinx](<https://devfeed.tech/tags/sphinx.md>), [tutorial](<https://devfeed.tech/tags/tutorial.md>)

### AI overview

An end-to-end tutorial on managing a Sphinx project with Bazel, including setup, documentation builds, local preview, extensions, and deployment to GitHub Pages.

### Source excerpt

An end-to-end tutorial on managing a Sphinx project with Bazel.

## Documenting Python Code with Sphinx

DevFeed: [Documenting Python Code with Sphinx](<https://devfeed.tech/articles/documenting-python-code-with-sphinx-40680.md>)

Original publisher: [Read original article](<https://radek.io/posts/documenting-python-code-with-sphinx/>)

Published: 2011-07-28T00:00:00Z

Content type: tutorial

Language: en

Sources: [Radek Pazdera](<https://devfeed.tech/sources/radek-pazdera.md>)

Topics: [Documentation](<https://devfeed.tech/topics/documentation.md>), [Python](<https://devfeed.tech/topics/python.md>), [Development](<https://devfeed.tech/topics/development.md>)

Tags: [code](<https://devfeed.tech/tags/code.md>), [documentation](<https://devfeed.tech/tags/documentation.md>), [html](<https://devfeed.tech/tags/html.md>), [installation](<https://devfeed.tech/tags/installation.md>), [python](<https://devfeed.tech/tags/python.md>), [rst](<https://devfeed.tech/tags/rst.md>), [setup](<https://devfeed.tech/tags/setup.md>), [software-development](<https://devfeed.tech/tags/software-development.md>), [sphinx](<https://devfeed.tech/tags/sphinx.md>)

### AI overview

A tutorial on documenting Python code with Sphinx. It explains why documentation belongs near source code, how to install Sphinx, set up its documentation directory, enable autodoc, and write content in reStructuredText.

### Source excerpt

I build software products and write on the Internet.