Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Mar 21, 2022
1 parent 11023ea commit 156d7a3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,10 @@ Write a Markdown table with a margin
``margin`` attribute can be available for all of the text format writer classes.

Write a Markdown table to a stream or a file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
`Refer an example <https://github.com/thombashi/pytablewriter/blob/master/examples/py/stream/configure_stream.py>`__

Write a table to an Excel sheet
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:Sample Code:
Expand Down
10 changes: 9 additions & 1 deletion docs/make_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,17 @@ def write_examples(maker: ReadmeMaker) -> None:
examples_root.joinpath("table_format", "text", "markdown_example_with_margin.txt")
)

with maker.indent():
maker.write_chapter("Write a Markdown table to a stream or a file")
maker.write_lines(
[
"`Refer an example <https://github.com/thombashi/pytablewriter/blob/master/examples/py/stream/configure_stream.py>`__"
]
)

maker.write_chapter("Write a table to an Excel sheet")
maker.write_file(
examples_root.joinpath("table_format", "binary", "spreadsheet", "exel_single_example.txt")
examples_root.joinpath("table_format", "binary", "spreadsheet", "excel_single_example.txt")
)

maker.write_chapter("Write a Unicode table")
Expand Down

0 comments on commit 156d7a3

Please sign in to comment.