https://github.com/ulrobix/sphinxcontrib-contentui

Sphinx extension that is rendered as HTML widgets
https://github.com/ulrobix/sphinxcontrib-contentui

Last synced: 24 days ago
JSON representation

Sphinx extension that is rendered as HTML widgets

• Host: GitHub
• URL: https://github.com/ulrobix/sphinxcontrib-contentui
• Owner: ulrobix
• License: mit
• Created: 2017-02-25T20:41:19.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-07T07:51:19.000Z (almost 2 years ago)
• Last Synced: 2024-09-19T15:18:30.221Z (3 months ago)
• Language: Python
• Size: 19.5 KB
• Stars: 13
• Watchers: 4
• Forks: 17
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-docs - Contentui

README

        
.. -*- restructuredtext -*-

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

Contentui extension for Sphinx

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

This is a modified fork of Serge Domkowski's `examplecode extension

`_

for Sphinx.

About

=====

This is a simple extension that is rendered as HTML widgets:

- `Content tab `_

- `Column content `_

- `Toggle header `_

Example

-------

`All-in-One Example `_

Installation

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

.. code-block:: bash

    $ pip install sphinxcontrib-contentui

Enabling the extension in Sphinx

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Just add sphinxcontrib.contentui to the list of extensions in the **conf.py** file. For example:

.. code-block:: bash

    extensions = ['sphinxcontrib.contentui']

Documentation

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

Full documentation for end users can be found in the "docs" folder.

It is also available online on `Read The Docs `_

.. Links:

.. _Sphinx: http://sphinx.pocoo.org/`

License

-------

sphinxcontrib-contentui is licensed under the MIT License