https://github.com/tdi/sphinxcontrib-manpage

Sphinx role to render html links to online Linux manpages
https://github.com/tdi/sphinxcontrib-manpage

manpage manpages python sphinx sphinx-doc sphinx-plugin

Last synced: 5 months ago
JSON representation

Sphinx role to render html links to online Linux manpages

• Host: GitHub
• URL: https://github.com/tdi/sphinxcontrib-manpage
• Owner: tdi
• License: apache-2.0
• Created: 2013-09-30T20:29:58.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2020-02-02T13:16:12.000Z (over 6 years ago)
• Last Synced: 2025-11-30T13:10:45.808Z (7 months ago)
• Topics: manpage, manpages, python, sphinx, sphinx-doc, sphinx-plugin
• Language: Python
• Size: 12.7 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
sphinxcontrib-manpage

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

Sphinx role to render html links to online Linux manpages. 

Usage

-----

`:linuxman:ls(1)` will render a link to http://linux.die.net/man/1/ls. 

Config

------

You can configure custom url with a `linux_man_url_regex` directive in `conf.py`, the syntax is as

follows:

`http://linux.die.net/man/$num/$topic`, where `$num` is the man page number and `$topic` is a

string. 

Licence and credits

-------------------

Copyright (c) Dariusz Dwornikowski and Poznan University of Technology. 

Distributed under the Apache Commons 2.0.