https://github.com/shirou/sphinxcontrib-satysfibuilder

sphinx SATysFi builder just for fun
https://github.com/shirou/sphinxcontrib-satysfibuilder

Last synced: 2 months ago
JSON representation

sphinx SATysFi builder just for fun

• Host: GitHub
• URL: https://github.com/shirou/sphinxcontrib-satysfibuilder
• Owner: shirou
• License: lgpl-3.0
• Created: 2018-02-11T14:30:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-12T05:43:55.000Z (over 7 years ago)
• Last Synced: 2025-01-25T12:11:07.367Z (4 months ago)
• Language: Python
• Size: 18.2 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-satysfi - sphinxcontrib-satysfibuilder - sphinx SATysFi builder just for fun (Uncategorized / Uncategorized)

README

        
Sphinx SATySFi builder

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

Sphinx to SATySFi builder.

Note: This is just a trial builder. It will NOT publish to pypi and not implement all of SATySFi features.

Satysfi: https://github.com/gfngfn/SATySFi

Setting

=======

Install

-------

::

   % pip install -e "git+https://github.com/shirou/sphinxcontrib-satysfibuilder#egg=sphinxcontrib_satysfibuilder"

Configure Sphinx

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

To enable this extension, add ``sphinxcontrib.satysfibuilder`` module to extensions

option at `conf.py`.

::

   # Enabled extensions

   extensions = ['sphinxcontrib.satysfibuilder']

   # Add title, author information

   satisfy_documents = [

       (master_doc, 'SATySFi.saty', 'SATySFi Builder', 'shirou'),

   ]

How to use

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

::

  % make satysfi

Repository

==========

https://github.com/shirou/sphinxcontrib-satysfibuilder

Sample

-------

License

========

LGPL v3.

Same as SATySFi original. See LICENSE file.