Skip to content

v3.0.1

Latest

Choose a tag to compare

@JeanExtreme002 JeanExtreme002 released this 12 Sep 06:04
58f8292

What's changed

A documentation-only release. No library code changed between v3.0.0 and v3.0.1 — the PyPI artifact differs from 3.0.0 only in __version__. If you are already on 3.0.0 there is nothing to gain by upgrading; the version exists so the docs site has a tag to build from.

Documentation

  • The Sphinx sidebar is grouped by topic. Every {toctree} now carries a :caption:, which the Read the Docs theme renders as a section header, so the navigation reads as nine labelled groups instead of one long list (#100)

    Getting Started · Core Workflow · Inspecting the Process · Pointers
    Memory Allocation · Tools · API Reference · Additional Notes · Project
    
  • One hop fewer to the content. The old guide/index hub page — a caption "User's Guide" leading to a page "User Guide" leading to a "What's covered" restatement of its own table of contents — is gone. The guide's pages are listed directly under the captions, and the two links that pointed at the hub now point at Opening a process (#100)

  • The API reference is split into three captioned groups, and the vague "Advanced" caption is now "Memory Allocation" (#100)

  • Fixed a stale comment in the Makefile that still named Furo as the docs theme; it has been sphinx_rtd_theme since the migration (#100)

Why the version bump

Read the Docs serves /en/stable/ from the highest semver tag. That was v3.0.0, the commit before the docs change, so stable kept showing the old navigation even though /en/latest/ had already rebuilt from main. Tagging v3.0.1 moves stable onto the current docs (#101)

Install

pip install --upgrade PyMemoryEditor

📖 Full documentation: pymemoryeditor.readthedocs.io

Full Changelog: v3.0.0...v3.0.1