Skip to content

Conversation

@nikblanchet
Copy link
Contributor

@nikblanchet nikblanchet commented Nov 29, 2025

Summary

Closes long-open issue #1516 by integrating feedback from the WTD Portland 2021 Sphinx unconference session, updated for 2025 accuracy.

What was covered

Topic Where
Code introspection, docs-as-code, RST power sphinx-community.rst
Intersphinx, domains, extensions sphinx.rst (new sections)
Navigation/toctree challenges, learning curve sphinx-community.rst
Markdown/MyST (recommonmark deprecated) sphinx.rst (new section)
pydata-sphinx-theme, theming complexity sphinx-themes.rst, sphinx-community.rst
Alternative generators (Jamstack momentum) tools/index.rst (new section)

What was excluded

Topic Reason
"Sphinx maintained by two people on weekends" Now 9 active maintainers
Sphinx 1.8 upgrade concerns 7 years outdated (current: 8.x)
"AsciiDoc is a one-man show" Now Eclipse Foundation backed
Personal quotes, 2021-specific tasks Not actionable in 2025

Coverage: 20 of 31 unconference points (65%) - excluded items were outdated or non-actionable. (I can provide a complete breakdown if needed.)

Suggested follow-up

A larger tools section restructure:

  • Keep page contents consistent by clearer IA: Tool category > tool > tool pages
    • Ex: Documentation generators > Sphinx > Introduction [to Sphinx], [Sphinx] Themes, Community perspectives [on Sphinx]
    • Ex: CI > Travis CI
    • Ex: Linters > Vale
  • Split testing.rst into focused pages (ci-cd, build-validation, link-checking, linting)
  • Rename tools/sphinx to tools/sphinx-intro or rename to tools/sphinx/intro and create a new tools/sphinx page that's just a TOC-style page

Closes #1516

Generated with Claude Code
Steered and verified by @nikblanchet (high-key montada, mana)


📚 Documentation preview 📚: https://writethedocs-www--2484.org.readthedocs.build/

- Restructure docs/guide/tools/index.rst with explicit sections for Sphinx,
  other tools, and testing
- Add new sphinx-community.rst page capturing community perspectives
  from WTD Portland 2021 unconference discussions
- Enhance sphinx.rst with MyST Parser and key features/extensions sections
- Add pydata-sphinx-theme and Shibuya to sphinx-themes.rst

Closes writethedocs#1516

Generated with [Claude Code](https://claude.com/claude-code)
Steered and verified by @nikblanchet (tô no low-key feitiço)
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.

Dump notes from Sphinx unconference

1 participant