2017-04-26 15:47:02 +03:00
|
|
|
This directory contains various scripts for use while developing.
|
|
|
|
|
|
2017-04-28 13:44:45 +03:00
|
|
|
generate_toc
|
|
|
|
|
------------
|
2017-05-02 17:46:47 +03:00
|
|
|
Generates the table of contents (toc.md). Requires Pandoc.
|
2017-04-28 13:44:45 +03:00
|
|
|
Usage:
|
2017-05-05 15:31:08 +03:00
|
|
|
|
2017-04-28 13:44:45 +03:00
|
|
|
cd docs
|
|
|
|
|
../scripts/generate_toc.sh
|
|
|
|
|
|
|
|
|
|
|
2017-05-02 17:46:47 +03:00
|
|
|
html_to_markdown_toc.py
|
|
|
|
|
-----------------------
|
2017-04-28 13:44:45 +03:00
|
|
|
Used by generate_toc.
|
|
|
|
|
|
|
|
|
|
|
2017-04-26 15:47:02 +03:00
|
|
|
docs2html
|
|
|
|
|
---------
|
|
|
|
|
Converts markdown docs to html for preview. Requires Pandoc.
|
|
|
|
|
Usage:
|
|
|
|
|
|
|
|
|
|
cd docs
|
|
|
|
|
../scripts/docs2html.sh
|
|
|
|
|
|
|
|
|
|
|
2017-05-05 15:31:08 +03:00
|
|
|
generate_ref
|
|
|
|
|
------------
|
|
|
|
|
Generates a class reference.
|
|
|
|
|
Usage:
|
|
|
|
|
|
|
|
|
|
cd docs
|
|
|
|
|
../bin/python ../scripts/generate_ref.py > class_reference.md
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
generate_all
|
|
|
|
|
------------
|
|
|
|
|
Does everything:
|
|
|
|
|
|
|
|
|
|
- Generates the class reference using generate_ref
|
|
|
|
|
- Generates the table of contents using generate_toc
|
|
|
|
|
- Converts to HTML for visual inspection using docs2html
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
|
|
|
|
|
cd docs
|
|
|
|
|
../scripts/generate_all.sh
|
|
|
|
|
|
|
|
|
|
|
2017-04-26 15:47:02 +03:00
|
|
|
test_python3
|
|
|
|
|
------------
|
|
|
|
|
Creates a Python 3 virtualenv, clones the project into it, and runs the tests.
|
|
|
|
|
Usage:
|
|
|
|
|
|
|
|
|
|
./test_python3.sh
|
