Skip to content

Commit

Permalink
docs: greatly improve docs and fix README example call
Browse files Browse the repository at this point in the history
  • Loading branch information
BjoernLudwigPTB committed Mar 15, 2021
1 parent cb0a755 commit 7e5e1dd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ displayed in <b>several tables</b> based on <b>filter criteria</b>.
As a starting point you could call

```shell
$ python -m main.py input/my_test_download.xml
$ python -m pyxml2pdf.main input/template.xml
```

which will download a publicly available XML file into the folder *input* and process
Expand Down
27 changes: 9 additions & 18 deletions docs/pyxml2pdf.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
=========
pyxml2pdf
=========
=============
API reference
=============

core
====

downloader
----------
properties
==========

.. automodule:: pyxml2pdf.core.downloader
.. automodule:: input.properties
:members:
:private-members:
:undoc-members:

core
====

rows
----

Expand Down Expand Up @@ -82,14 +81,6 @@ builder
styles
======

cell_formattings
----------------

.. automodule:: pyxml2pdf.styles.cell_formattings
:members:
:private-members:
:undoc-members:

table_styles
------------

Expand Down

0 comments on commit 7e5e1dd

Please sign in to comment.