Skip to content

The packages / Omnidocs / Provider

omnidocs/sphinx

Omnidocs Sphinx: a Sphinx manual as an omnidocs manual, from the JSON builder's output (sphinx-build -b json) and its objects.inv - pages in the toctrees' order, admonitions and versionadded as callouts, highlighted code in frames, the API entries at their anchors with their signatures.

composer require omnidocs/sphinx:1.x-dev

No package of the ecosystem has a stable release yet: the command asks for its development branch.

Sheet

Floor
Provider · Omnidocs
Licence
MIT
Branch
1.x
Verified for real
Verified in part

- Not verified: other domains than Python's (cpp:, js:) beyond their names; themes' extra context; MyST (Markdown) projects; math (MathJax is a script, left out: formulas show as their source).

From its README
Keywords
documentationsphinxrestructuredtextobjects.invintersphinxomnidocs

Manual

This package has neither a docs/ folder nor a README.

Dependencies

It requires

  • omnisense/omnidocs

    Omnidocs: one model of a manual, whatever wrote it - Markdown, Sphinx, Doxygen, JSDoc: its versions, its pages (title, contents, headings, the file to edit), its API entries and their anchors, read through one source contract; a search index a static page searches, and the HTML conventions of symfony.com/doc (callouts, versionadded, code with captions and tabs) every format renders to.

    Packagist · 1.x-dev Verified in part Manual