Skip to content

📝 docs(readme): simplify README, link to Sphinx docs#558

Merged
gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat:docs
Mar 23, 2026
Merged

📝 docs(readme): simplify README, link to Sphinx docs#558
gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat:docs

Conversation

@gaborbernat
Copy link
Copy Markdown
Member

The full documentation now lives on ReadTheDocs (#557), so the README no longer needs to duplicate all the usage examples, CLI reference, and implementation notes.

📝 Trimmed it down to a quick start snippet (install, basic usage, reverse lookup, output formats) with links to the full docs. Follows the same pattern as virtualenv's README.

pipdeptree's documentation lived entirely in README.md, limiting
discoverability and making it hard to organize growing content like
output format examples and CLI reference.

Sphinx with furo theme mirrors the virtualenv project's docs setup and
enables ReadTheDocs hosting. All examples use real pipdeptree output
from the dev environment. sphinx-argparse-cli auto-generates the CLI
reference from the argparse parser so it stays in sync with the code.

Also fixes mermaid output to use <br/> instead of \n for node label
line breaks, since Mermaid's JS renderer treats \n as literal text.
@gaborbernat gaborbernat merged commit ddd6a09 into tox-dev:main Mar 23, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant