fx-doc

Release 0.12.0

Build reStructuredText to HTML, PDF and text

Homepage PyPI CSS

Keywords
build, document, reStructuredText, HTML, PDF, texta, builder
License
MIT
Install
pip install fx-doc==0.12.0

Documentation

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
===========

Install following pacakges:

    $ apt-get install python 
    $ apt-get install texlive-full  # required for PDF building
    $ sudo pip install virtualenv

    $ ./env init
    $ . ./venv/bin/activate
    $ ./env install
    $ fx-doc build doc dest
    $ fx-doc serve dest

Note: For mac, we can use MacTeX [1] instead of `texlive-full`.

Distribute
==========

    $ ./push-pip.sh

Links
======

[1] https://www.tug.org/mactex/mactex-download.html

Stats

Dependencies
11
Dependent packages
0
Dependent repositories
0
Total releases
31
Latest release
First release
Stars
1
Forks
1
Watchers
1
Contributors
2
Repository size
5.46 MB
SourceRank
5

Releases

0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.0
0.6.1
0.5.5
0.5.4
0.5.3
See all 31 releases

Contributors

kevin leptons YOMI


See all contributors

Login to resync this project