https://github.com/dgw/sphinx-rfcsection

Intelligently auto-titles Sphinx links to RFC sections
https://github.com/dgw/sphinx-rfcsection

Last synced: about 1 month ago
JSON representation

Intelligently auto-titles Sphinx links to RFC sections

• Host: GitHub
• URL: https://github.com/dgw/sphinx-rfcsection
• Owner: dgw
• Created: 2022-01-17T02:34:15.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-06T14:38:09.000Z (over 2 years ago)
• Last Synced: 2024-10-07T01:45:08.334Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# sphinx-rfcsection

`sphinx-rfcsection` is a minimal Sphinx extension to add sane automatic titles

to RFC references with sections included.

## Implementation details

For simplicity, this extension subclasses Sphinx's built-in `:rfc:` role from

`sphinx.roles.RFC` (part of the Sphinx code since version 2.x). Just a small

amount of custom logic automatically sets a custom title on the reference if

appropriate, before delegating right back to the built-in code.

## License

[GPLv3](https://opensource.org/licenses/GPL-3.0)