Revised the documentation in README.rst and intro.rst.
This commit is contained in:
parent
e30d1257e5
commit
12ccf658bf
32
README.rst
32
README.rst
@ -7,7 +7,8 @@ Description
|
|||||||
===========
|
===========
|
||||||
|
|
||||||
*Mia! Accounting* is an accounting module for Flask_ applications.
|
*Mia! Accounting* is an accounting module for Flask_ applications.
|
||||||
It implements `double-entry bookkeeping`_, and generates the following
|
It is designed both for mobile and desktop environments. It
|
||||||
|
implements `double-entry bookkeeping`_. It generates the following
|
||||||
accounting reports:
|
accounting reports:
|
||||||
|
|
||||||
* Trial balance
|
* Trial balance
|
||||||
@ -18,6 +19,18 @@ In addition, *Mia! Accounting* tracks offsets for unpaid payables and
|
|||||||
receivables.
|
receivables.
|
||||||
|
|
||||||
|
|
||||||
|
Live Demonstration and Test Site
|
||||||
|
================================
|
||||||
|
|
||||||
|
There is a `live demonstration`_ for *Mia! Accounting*. It runs the
|
||||||
|
same code as the `test site`_ in the `source distribution`_. It is
|
||||||
|
the simplest website that works with *Mia! Accounting*. It is also
|
||||||
|
used in the automatic tests.
|
||||||
|
|
||||||
|
If you do not have a running Flask application or do not know how to
|
||||||
|
start one, you may start with the test site.
|
||||||
|
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
@ -27,22 +40,10 @@ Install *Mia! Accounting* with ``pip``:
|
|||||||
|
|
||||||
pip install mia-accounting
|
pip install mia-accounting
|
||||||
|
|
||||||
You may also download the from the `PyPI project page`_ or the
|
You may also download from the `PyPI project page`_ or the
|
||||||
`release page`_ on the `Git repository`_.
|
`release page`_ on the `Git repository`_.
|
||||||
|
|
||||||
|
|
||||||
Test Site and Live Demonstration
|
|
||||||
================================
|
|
||||||
|
|
||||||
You may find a working example in the `test site`_ in the
|
|
||||||
`source distribution`_. It is the simplest website that works with
|
|
||||||
*Mia! Accounting*. It is used in the automatic tests. It is the same
|
|
||||||
code run for `live demonstration`_.
|
|
||||||
|
|
||||||
If you do not have a running Flask application or do not know how to
|
|
||||||
start one, you may start with the test site.
|
|
||||||
|
|
||||||
|
|
||||||
Prerequisites
|
Prerequisites
|
||||||
=============
|
=============
|
||||||
|
|
||||||
@ -191,9 +192,9 @@ Authors
|
|||||||
|
|
||||||
.. _Flask: https://flask.palletsprojects.com
|
.. _Flask: https://flask.palletsprojects.com
|
||||||
.. _double-entry bookkeeping: https://en.wikipedia.org/wiki/Double-entry_bookkeeping
|
.. _double-entry bookkeeping: https://en.wikipedia.org/wiki/Double-entry_bookkeeping
|
||||||
|
.. _live demonstration: https://accounting.imacat.idv.tw
|
||||||
.. _test site: https://github.com/imacat/mia-accounting/tree/main/tests/test_site
|
.. _test site: https://github.com/imacat/mia-accounting/tree/main/tests/test_site
|
||||||
.. _source distribution: https://pypi.org/project/mia-accounting/#files
|
.. _source distribution: https://pypi.org/project/mia-accounting/#files
|
||||||
.. _live demonstration: https://accounting.imacat.idv.tw
|
|
||||||
.. _PyPI project page: https://pypi.org/project/mia-accounting
|
.. _PyPI project page: https://pypi.org/project/mia-accounting
|
||||||
.. _release page: https://github.com/imacat/mia-accounting/releases
|
.. _release page: https://github.com/imacat/mia-accounting/releases
|
||||||
.. _Git repository: https://github.com/imacat/mia-accounting
|
.. _Git repository: https://github.com/imacat/mia-accounting
|
||||||
@ -204,6 +205,5 @@ Authors
|
|||||||
.. _Tempus-Dominus: https://getdatepicker.com
|
.. _Tempus-Dominus: https://getdatepicker.com
|
||||||
.. _UserUtilityInterface: https://mia-accounting.readthedocs.io/en/latest/accounting.utils.html#accounting.utils.user.UserUtilityInterface
|
.. _UserUtilityInterface: https://mia-accounting.readthedocs.io/en/latest/accounting.utils.html#accounting.utils.user.UserUtilityInterface
|
||||||
.. _init_app: https://mia-accounting.readthedocs.io/en/latest/accounting.html#accounting.init_app
|
.. _init_app: https://mia-accounting.readthedocs.io/en/latest/accounting.html#accounting.init_app
|
||||||
.. _flask_sqlalchemy.SQLAlchemy.create_all: https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/api/#flask_sqlalchemy.SQLAlchemy.create_all
|
|
||||||
.. _Bootstrap navigation bar: https://getbootstrap.com/docs/5.3/components/navbar/
|
.. _Bootstrap navigation bar: https://getbootstrap.com/docs/5.3/components/navbar/
|
||||||
.. _documentation on Read the Docs: https://mia-accounting.readthedocs.io
|
.. _documentation on Read the Docs: https://mia-accounting.readthedocs.io
|
||||||
|
@ -2,7 +2,8 @@ Introduction
|
|||||||
============
|
============
|
||||||
|
|
||||||
*Mia! Accounting* is an accounting module for Flask_ applications.
|
*Mia! Accounting* is an accounting module for Flask_ applications.
|
||||||
It implements `double-entry bookkeeping`_, and generates the following
|
It is designed both for mobile and desktop environments. It
|
||||||
|
implements `double-entry bookkeeping`_. It generates the following
|
||||||
accounting reports:
|
accounting reports:
|
||||||
|
|
||||||
* Trial balance
|
* Trial balance
|
||||||
@ -13,6 +14,18 @@ In addition, *Mia! Accounting* tracks offsets for unpaid payables and
|
|||||||
receivables.
|
receivables.
|
||||||
|
|
||||||
|
|
||||||
|
Live Demonstration and Test Site
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
There is a `live demonstration`_ for *Mia! Accounting*. It runs the
|
||||||
|
same code as the `test site`_ in the `source distribution`_. It is
|
||||||
|
the simplest website that works with *Mia! Accounting*. It is also
|
||||||
|
used in the automatic tests.
|
||||||
|
|
||||||
|
If you do not have a running Flask application or do not know how to
|
||||||
|
start one, you may start with the test site.
|
||||||
|
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
@ -22,22 +35,10 @@ Install *Mia! Accounting* with ``pip``:
|
|||||||
|
|
||||||
pip install mia-accounting
|
pip install mia-accounting
|
||||||
|
|
||||||
You may also download the from the `PyPI project page`_ or the
|
You may also download from the `PyPI project page`_ or the
|
||||||
`release page`_ on the `Git repository`_.
|
`release page`_ on the `Git repository`_.
|
||||||
|
|
||||||
|
|
||||||
Test Site and Live Demonstration
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
You may find a working example in the `test site`_ in the
|
|
||||||
`source distribution`_. It is the simplest website that works with
|
|
||||||
*Mia! Accounting*. It is used in the automatic tests. It is the same
|
|
||||||
code run for `live demonstration`_.
|
|
||||||
|
|
||||||
If you do not have a running Flask application or do not know how to
|
|
||||||
start one, you may start with the test site.
|
|
||||||
|
|
||||||
|
|
||||||
Prerequisites
|
Prerequisites
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
@ -110,9 +111,9 @@ Refer to the `documentation on Read the Docs`_.
|
|||||||
|
|
||||||
.. _Flask: https://flask.palletsprojects.com
|
.. _Flask: https://flask.palletsprojects.com
|
||||||
.. _double-entry bookkeeping: https://en.wikipedia.org/wiki/Double-entry_bookkeeping
|
.. _double-entry bookkeeping: https://en.wikipedia.org/wiki/Double-entry_bookkeeping
|
||||||
|
.. _live demonstration: https://accounting.imacat.idv.tw
|
||||||
.. _test site: https://github.com/imacat/mia-accounting/tree/main/tests/test_site
|
.. _test site: https://github.com/imacat/mia-accounting/tree/main/tests/test_site
|
||||||
.. _source distribution: https://pypi.org/project/mia-accounting/#files
|
.. _source distribution: https://pypi.org/project/mia-accounting/#files
|
||||||
.. _live demonstration: https://accounting.imacat.idv.tw
|
|
||||||
.. _PyPI project page: https://pypi.org/project/mia-accounting
|
.. _PyPI project page: https://pypi.org/project/mia-accounting
|
||||||
.. _release page: https://github.com/imacat/mia-accounting/releases
|
.. _release page: https://github.com/imacat/mia-accounting/releases
|
||||||
.. _Git repository: https://github.com/imacat/mia-accounting
|
.. _Git repository: https://github.com/imacat/mia-accounting
|
||||||
@ -121,6 +122,5 @@ Refer to the `documentation on Read the Docs`_.
|
|||||||
.. _FontAwesome: https://fontawesome.com
|
.. _FontAwesome: https://fontawesome.com
|
||||||
.. _Decimal.js: https://mikemcl.github.io/decimal.js
|
.. _Decimal.js: https://mikemcl.github.io/decimal.js
|
||||||
.. _Tempus-Dominus: https://getdatepicker.com
|
.. _Tempus-Dominus: https://getdatepicker.com
|
||||||
.. _flask_sqlalchemy.SQLAlchemy.create_all: https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/api/#flask_sqlalchemy.SQLAlchemy.create_all
|
|
||||||
.. _Bootstrap navigation bar: https://getbootstrap.com/docs/5.3/components/navbar/
|
.. _Bootstrap navigation bar: https://getbootstrap.com/docs/5.3/components/navbar/
|
||||||
.. _documentation on Read the Docs: https://mia-accounting.readthedocs.io
|
.. _documentation on Read the Docs: https://mia-accounting.readthedocs.io
|
||||||
|
Loading…
Reference in New Issue
Block a user