Metadata-Version: 2.1
Name: fx-doc
Version: 0.3.0
Summary: Build reStructuredText to HTML, PDF and text
Home-page: https://github.com/kevin-leptons/fx-doc
Author: Kevin Leptons
Author-email: kevin.leptons@gmail.com
License: MIT
Description: fx-doc
        ======
        
        Build HTML, PDF from reStructuredText.
        
        Install
        =======
        
            $ pip install fx-doc
        
        Using
        =====
        
        Compile reStructuredText to document files
        -----------------------------------------
        
            $ fx-doc build SRC DEST [OPTIONS]
        
        * SRC: Directory contains reStructuredText source files.
        
        * DEST: Directory contains build files.
        
        * OPTIONS:
            * --dist: Compile and optimize, mean distribution.
            * --no-pdf: Don't make PDF file.
            * --no-html: Don't make HTML files.
            * --no-text: Don't make text files.
            * --force: Compile without cache files.
        
        Server build files on HTTP
        --------------------------
        
            $ fx-doc serve DEST [OPTIONS]
        
        * DEST: Directory contains compiled files. It is DEST of `fx-doc build`
          command.
        
        * OPTIONS:
            * --port: Port to listen, default is 8080
        
        Development
        ===========
        
            $ ./env init
            $ . ./venv/bin/activate
            $ ./env install
            $ fx-doc build doc dest
            $ fx-doc serve dest
        
        Distribute
        ==========
        
            $ ./push-pip.sh
        
Keywords: build,document,reStructuredText,HTML,PDF,texta
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/markdown
