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 buildcommand. -
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
Creat file "~/"
$ ./push-pip.sh
Links
1 maintainer
Metadata
1 maintainer
Release files for fx-doc 0.12.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fx-doc-0.12.0.tar.gz | 3.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fx_doc-0.12.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 6.7 MB
Release files / fx-doc-0.12.0.tar.gz
| Download URL | fx-doc-0.12.0.tar.gz |
|---|---|
| Size | 3.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
71ac002c1514e94e560ed1fe2483ca28bdd974e0adb2d729f512208b0568654f
|
|
BLAKE2b-256 checksum How to use checksums |
5b9cc8b6bffe0c31e89f6d15cfdf61c48c7daa56c4aac5ffb2fdb144a71d7718
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.5.3
|
Release files / fx_doc-0.12.0-py3-none-any.whl
| Download URL | fx_doc-0.12.0-py3-none-any.whl |
|---|---|
| Size | 3.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
82ec4a4b5ec0c2021fa5866a5423762552512e22001c74879b6c231dd8b41280
|
|
BLAKE2b-256 checksum How to use checksums |
9cf85cf0dff16d86e5f563730ae6d36877f3b134726da6ed12b315be6339d6d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.5.3
|
