Infinidat/infi.clickhouse_orm
1
1
Fork 0
mirror of https://github.com/Infinidat/infi.clickhouse_orm.git synced 2024-11-22 00:56:34 +03:00
Code Issues Packages Projects Releases Wiki Activity
3c38c8ec40
infi.clickhouse_orm/scripts
History
Itai Shirav 93747f7758 Improve docs
2020-02-08 18:14:50 +02:00
..
docs2html.sh - Added ne and not_in queryset operators 2017-06-15 12:19:17 +03:00
generate_all.sh Generate a class reference document 2017-05-05 15:31:08 +03:00
generate_ref.py Improve docs 2020-02-08 18:14:50 +02:00
generate_toc.sh Improve docs 2020-02-08 18:14:50 +02:00
html_to_markdown_toc.py Improve docs 2020-02-08 18:14:50 +02:00
README.md TRIVIAL 2017-05-15 08:35:29 +03:00
test_python3.sh need to run script under bash, otherwise virtualenv doesn't get activated 2017-04-28 18:18:04 +03:00

README.md

This directory contains various scripts for use while developing.

generate_toc

Generates the table of contents (toc.md). Requires Pandoc. Usage:

cd docs
../scripts/generate_toc.sh

html_to_markdown_toc.py

Used by generate_toc.

docs2html

Converts markdown docs to html for preview. Requires Pandoc. Usage:

cd docs
../scripts/docs2html.sh

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

test_python3

Creates a Python 3 virtualenv, clones the project into it, and runs the tests. Usage:

./test_python3.sh