Farshid/Ashouri

documentation

5 posts tagged “documentation”.

  1. 2025

  2. Format code examples in documentation with blacken-docs

    I decided to enforce that all code examples in the Datasette documentation be formatted using Black. Here's issue 1718 where I researched the options for doing this. I found the blacken-docs tool.

    python documentation formatting black ci/cd
    1 min read

  3. Build the official Python documentation locally

    First, checkout the cpython repo: $ git clone git@github.com:python/cpython cd into the directory: $ cd cpython/Doc To get a virtual environment with Sphinx and other required tools, run like this: $…

    python documentation sphinx git cli
    1 min read
  4. 2024

  5. Adding Sphinx autodoc to a project, and configuring Read The Docs to build it

    I built a new API reference page today for , using the Sphinx autodoc extension to extract docstrings from the code and use them to build a full class reference.

    sphinx autodoc read-the-docs python documentation
    3 min read
  6. 2023

  7. Check spelling using codespell

    Today I discovered codespell via this Rich commit. is a really simple spell checker that can be run locally or incorporated into a CI flow. codespell is designed to run against source code.

    spelling codespell python ci/cd documentation
    1 min read

  8. Generating documentation from tests using files-to-prompt and LLM

    I was experimenting with wasmtime-py today and found the current documentation didn't quite give me the information that I needed.

    llm ai documentation code-generation python
    2 min read