Skip to main content

Build reStructuredText to HTML, PDF and text

Project description


Build HTML, PDF from reStructuredText.


$ pip install fx-doc


Compile reStructuredText to document files

$ fx-doc build SRC DEST [OPTIONS]
  • SRC: Directory contains reStructuredText source files.

  • DEST: Directory contains build files.


    • --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.


    • --port: Port to listen, default is 8080


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.


Creat file "~/"

$ ./



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fx-doc-0.12.0.tar.gz (3.3 MB view hashes)

Uploaded Source

Built Distribution

fx_doc-0.12.0-py3-none-any.whl (3.3 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page