sphinx-contrib / context /

Filename Size Date modified Message
..
sphinxcontrib
49 B
1010 B
81 B
1.1 KB
.. -*- restructuredtext -*-

==========================
README for ConTeXt Builder
==========================

It's a ConTeXt builder for Sphinx. It is very primitive at present. It would
be a long time to implement full functions for the builder, since ConTeXt mkiv
is not stable.


Installing
==========

If you want to take a look and have a try, you can put the builder in your 
.extension directory. The conf.py needs some modification:

- Set the builder as a extension

     extensions = ['context']

- Set the config values

     context_documents = [
       ('index', 'document_name', u'Project Name',
        u'Your Name', 'manual'),
     ]

  It's the same with LaTeX builder's config setting.


Warning
=======

The ConTeXt builder do *not* support list, link, image, and so on. Actually
it only has some treatments on toctree and section, which are also very
primitive.

I'm kind of not knowing what to do with the builder. If you have any request,
please let me know. That will be a good start. 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.