Welcome to blockdiag on readthedocs’s documentation!

Sample

/home/docs/checkouts/readthedocs.org/user_builds/blockdiag-readthedocs/checkouts/latest/docs/_build/localmedia/_images/blockdiag-2c4a30018e654a7be0d93e3facdc992611f2b857.png

Usage

  1. Add sphinxcontrib.blockdiag extention to conf.py:

    extensions = ['sphinxcontrib.blockdiag', ]
    
  2. Add requirements.txt to your document’s directory (e.g. docs, doc):

    sphinxcontrib-blockdiag==1.1.1
    
  3. Setup readthedocs project

    • Use virtualenv: cheked
    • Requirements file: your requirements.txt
screen shots

Tips

Use unicode chars

/home/docs/checkouts/readthedocs.org/user_builds/blockdiag-readthedocs/checkouts/latest/docs/_build/localmedia/_images/blockdiag-4bdcd5b82b09f1c31ead886aee4303f31479f367.png
  1. Downloading & storing unicode font (*.ttf) to _static directory.

  2. Specify it in conf.py:

    # Use IPA P Gothic fonts: http://ossipedia.ipa.go.jp/ipafont/
    blockdiag_fontpath = '_static/ipagp00303/ipagp.ttf'
    

Indices and tables