https://github.com/sam-martin/sphinx-node-name-cheat-sheet

A site that makes it easy to figure out what node classes your Sphinx extension needs to use for the desired formatting.
https://github.com/sam-martin/sphinx-node-name-cheat-sheet

Last synced: 8 months ago
JSON representation

A site that makes it easy to figure out what node classes your Sphinx extension needs to use for the desired formatting.

• Host: GitHub
• URL: https://github.com/sam-martin/sphinx-node-name-cheat-sheet
• Owner: Sam-Martin
• License: mit
• Created: 2021-05-29T13:37:18.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-05-29T13:52:51.000Z (about 5 years ago)
• Last Synced: 2025-02-04T22:25:24.116Z (over 1 year ago)
• Language: Python
• Size: 347 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Sphinx Node Name Cheat Sheet

====================================

When writing Sphinx extensions I've never found an easy way to figure out what docutils or Sphinx

node classes I should be using to get the desired formatting.

This documentation is intended to be a quick reference to figure out what your favourite RST turns into when it gets parsed

into a docutils or Sphinx object within the RST rendering engine!

In creating the examples I used `RST | Sphinx | Sublime `_

as a reference as I found it incredibly useful when starting my Sphinx journey!