Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 3.8 KB

README.md

File metadata and controls

76 lines (59 loc) · 3.8 KB
Raw

QuickFIX-doc

Build Status

QuickFIX-doc parses QuickFIX data dictionary .xml files into descriptive reStructuredText files using RstCloth, and then runs them through the Sphinx documentation generation library for Python.

Usage

quickfixdoc PATH/TO/DD.xml PATH/TO/OUTPUT/DIRECTORY [BUILDER (default: html)]

Example:

> quickfixdoc ~/Documents/quickfix/spec/FIX44.xml ./FIX_44_Spec/
QuickFIXdoc
Generating documents for ~/Documents/quickfix/spec/FIX44.xml into ./FIX_44_Spec/
Running: /usr/local/opt/python/bin/python3.7 -m sphinx.cmd.build -M html ./FIX_44_Spec/ ./FIX_44_Spec/
Running Sphinx v1.8.1
making output directory...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 96 source files that are out of date
updating environment: 96 added, 0 changed, 0 removed
reading sources... [100%] index                                                                                                 
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                  
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.

The HTML pages are in FIX_44_Spec/html.

Install

  1. Ensure Python is installed on your machine - see here
  2. Run pip install https://github.com/connamara/QuickFIX-doc/archive/master.zip in a shell

Tests

  1. Ensure Docker is installed on your machine
  2. Execute ./acceptance.sh
  3. Detailed reports will be available for each vanilla FIX spec under ./acceptance/FIX*
    • Each subdirectory includes Robot Framework report files
    • log.html, report.html, and output.xml

Background and Goals

Writing specs for FIX sucks. QuickFIX-doc helps you "save time and look good" by taking care of the specification generation for you.

All you need is a valid QuickFIX data dictionary. No need for any custom word documents, no chance for human error, just run and view your nice beautiful spec.

Contributing

Please see the contribution guidelines

Credits

Contributers:

Connamara Systems

QuickFIX-doc is maintained and funded by Connamara Systems, llc.

The names and logos for Connamara Systems are trademarks of Connamara Systems, llc.

Licensing

QuickFIX-doc is Copyright © 2020 Connamara Systems, llc.

This software is available under the GPL and a commercial license. Please see the LICENSE file for the terms specified by the GPL license. The commercial license offers more flexible licensing terms compared to the GPL, and includes support services. Contact us for more information on the Connamara commercial license, what it enables, and how you can start commercial development with it.

This product includes software developed by quickfixengine.org (http://www.quickfixengine.org/). Please see the QuickFIX Software LICENSE for the terms specified by the QuickFIX Software License.