From b0b0d414c2590773ef8c5a9795bdb255ce9e06e4 Mon Sep 17 00:00:00 2001 From: Artur Barseghyan Date: Sun, 7 Aug 2022 23:59:14 +0200 Subject: [PATCH] Consolidate docs (#276) * Minor fixes in docs (old-style code) * Consolidate docs * Clean up --- CHANGELOG.rst | 14 +- CREDITS.rst | 14 +- QUICK_START.rst | 2 +- README.rst | 94 +- docs/changelog.rst | 1888 +---- ...entation.rst.distrib => documentation.rst} | 0 docs/{empty.rst.distrib => empty.rst} | 0 docs/index.rst | 7431 +---------------- docs/licenses.rst | 183 +- docs/quickstart.rst | 276 +- ...creenshots.rst.distrib => screenshots.rst} | 0 ...{submodules.rst.distrib => submodules.rst} | 0 scripts/build_docs.sh | 2 +- scripts/prepare_docs.sh | 572 +- scripts/rebuild_docs.sh | 2 +- setup.py | 2 +- .../contrib/apps/drf_integration/README.rst | 6 +- .../contrib/apps/drf_integration/TODOS.rst | 2 +- .../security/recaptcha/README.rst | 30 +- .../mailchimp_importer/README.rst | 2 +- src/fobi/wizard/README.rst | 2 +- 21 files changed, 603 insertions(+), 9919 deletions(-) rename docs/{documentation.rst.distrib => documentation.rst} (100%) rename docs/{empty.rst.distrib => empty.rst} (100%) rename docs/{screenshots.rst.distrib => screenshots.rst} (100%) rename docs/{submodules.rst.distrib => submodules.rst} (100%) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 78cf53fd..b197e9aa 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1324,7 +1324,7 @@ Existing files 2015-03-26 - `Checkbox select multiple - `_ + `_ field added. - Minor improvements (styling) in the Foundation 5 theme. - Initial configuration for tox tests. @@ -1360,22 +1360,22 @@ Existing files 2015-03-20 - `Decimal - `_ + `_ field added. - `Float - `_ + `_ field added. - `Slug - `_ + `_ field added. - `IP address - `_ + `_ field added. - `Null boolean - `_ + `_ field added. - `Time - `_ + `_ field added. - From now on using `simplejson` package in favour of `json`, since it can handle decimal data. diff --git a/CREDITS.rst b/CREDITS.rst index 968eea6e..2087cfdb 100644 --- a/CREDITS.rst +++ b/CREDITS.rst @@ -17,10 +17,10 @@ Thanks to the following people for their contributions: `_ for French translations and some minor fixes. - `Maximilian Kindshofer - `_ + `_ for German translations. - `Thomas Wajs - `_ + `_ for number of minor yet valuable fixes. - `garmoncheg `_ @@ -29,20 +29,20 @@ Thanks to the following people for their contributions: `_ for number of Django 1.9 support fixes. - `Mario Taddei - `_ + `_ for his initiative to make `Select multiple with max` plugin. - `Andy Babic - `_ + `_ for improvements in the generic integration processor and contributions to the ``wagtail_integration`` contrib app. - `Heldroe - `_ + `_ for minor fixes. - `Michal Dabski - `_ + `_ for minor fixes. - `Marcos Amorim - `_ + `_ for number of validation improvements. - `Grzegorz Bialy `_ diff --git a/QUICK_START.rst b/QUICK_START.rst index cdcbdbc5..11575378 100644 --- a/QUICK_START.rst +++ b/QUICK_START.rst @@ -10,7 +10,7 @@ several parts listed below:: Part 1: standard Django installation ==================================== Example project code available `here -`_. +`_. Installation and configuration ------------------------------ diff --git a/README.rst b/README.rst index 773f9c28..81a6b0a4 100644 --- a/README.rst +++ b/README.rst @@ -28,8 +28,8 @@ handling the submitted form data). :target: https://github.com/barseghyanartur/django-fobi/#License :alt: GPL-2.0-only OR LGPL-2.1-or-later -.. image:: https://coveralls.io/repos/github/barseghyanartur/django-fobi/badge.svg?branch=master - :target: https://coveralls.io/github/barseghyanartur/django-fobi?branch=master +.. image:: https://coveralls.io/repos/github/barseghyanartur/django-fobi/badge.svg?branch=main + :target: https://coveralls.io/github/barseghyanartur/django-fobi?branch=main :alt: Coverage Prerequisites @@ -138,7 +138,7 @@ Some of the upcoming/in-development features/improvements are: - Foundation 6 support. See the `TODOS -`_ +`_ for the full list of planned-, pending- in-development- or to-be-implemented features. @@ -1519,10 +1519,10 @@ Make changes to an existing theme As said above, making your own theme from scratch could be costly. Instead, you can override/reuse an existing one and change it to your needs with minimal efforts. See the `override simple theme -`_ +`_ example. In order to see it in action, run the project with `settings_override_simple_theme -`_ +`_ option: .. code-block:: sh @@ -1913,59 +1913,67 @@ Fields marked with asterisk (*) fall under the definition of text elements. It's possible to provide `Dynamic initial values`_ for text elements. - `Boolean (checkbox) - `_ + `_ +- `Checkbox select multiple + `_ - `Date - `_ -- `DateTime - `_ + `_ - `Date drop down (year, month, day selection drop-downs) - `_ + `_ +- `DateTime + `_ - `Decimal - `_ + `_ - `Duration - `_ + `_ - `Email* - `_ + `_ - `File - `_ + `_ - `Float - `_ + `_ - `Hidden* -