Commit graph

30 commits

Author SHA1 Message Date
Glandos
ff4de78b56
Reduce the size of showcase images (#899)
Fixes #875

Original showcase images are kept in another directory, and compressed
in webp in the distributed directory.
Since they won't change so much, let's keep them in git.
2021-10-30 17:30:59 +02:00
d2c96c5bc6
Enhance Docker documentation. (#882)
* Enhance Docker documentation.

Fixes #868

* Adress @zorun feedback.

* Update installation.rst
2021-10-22 17:56:41 +02:00
2b7a6f31a2 @zorun feedback. 2021-10-21 09:16:00 +02:00
34577f73cb Update release instructions. 2021-10-21 09:16:00 +02:00
3fd69f2267
Prepare 5.0 (#866)
* Update changelog.

Based on the work done in #570 and #834 by @Natim and @Glandos.

* Update contributing.rst release instructions.

* Update documentation configuration.

* Update translations

* Update translation strings

* Preparing release 5.0.0

* Back to development: 5.0.1
2021-10-19 23:01:29 +02:00
Baptiste Jonglez
e626a1cbea Implement security best practices using Flask-Talisman 2021-10-10 22:06:33 +02:00
Glandos
45f4d8f8b0 Using one job for all linting and doc generation
Requirements for doc are now an extra require in setup.cfg
2021-06-03 22:35:49 +02:00
Jocelyn Delalande
55bce593f0 Use venv module rather than virtualenv
- simpler to use
- lighter dependency (or no dependency at all, depending on python distribution)
- retrocompatible

virtualenv package from pip to acheive virtual environment feature is no longer
needed, except for projects which need to support py2, which is no longer our
case.

Also, reword "virtualenv" to "virtual environment" in doc, to avoid confusion
with pip package name.

Ref #483
2020-07-26 20:14:59 +02:00
Rémy HUBSCHER
6129191b26
Fix sqlite only migration. (#579) 2020-04-25 11:55:46 +02:00
zorun
e458da954d
Reorganize "Contributing" documentation to be more accessible to new contributors (#573)
* Reorganize "Contributing" documentation to be more accessible to new contributors

The following changes were done:

- move "How to contribute" first, and "Set up a dev environment" as the
  second section.  This way, a new contributor has access to the most
  general information first, instead of the very specific "dev
  environment" documentation.

- reduce "How to contribute" / "As a developer" by moving the part about
  tests to a new "Contributing as a developer" section (see below).  This
  way, all types of contributions get roughly the same amount of text in
  the first "How to contribute" section.

- add a new "Contributing as a developer" section, which lists items that
  are useful when preparing a code contribution (running tests, formatting
  code, create database migration).  These items were moved either from
  "How to contribute" or from "Set up a dev environment".

* Add brief documentation about updating and adding tests

Co-authored-by: Baptiste Jonglez <git@bitsofnetworks.org>
2020-04-25 11:49:50 +02:00
zorun
d4ad149a63
Improve documentation regarding database migrations (#569) 2020-04-24 13:45:39 +02:00
Rémy HUBSCHER
8e6643302f
Add a word about isort in the contributing docs. (#564) 2020-04-22 09:42:50 +02:00
Rémy HUBSCHER
5d3266873e
Update known working set. (#558)
* Update known working set.

* Pin dependencies in setup.cfg.

* Cleanup Makefile.

* Try the python_version trick.
2020-04-21 10:30:13 +02:00
Glandos
91ef80ebb7
Fix spelling (#552) 2020-04-12 10:45:35 +02:00
Allan Nordhøy
da89c35390
Spelling in documentation fixed, Weblate link (#551) 2020-04-12 09:58:00 +02:00
José Antonio de la Torre
37f2e38af3 Added better way to install ihatemoney 2019-10-14 23:28:44 +02:00
José Antonio de la Torre
2758b46983 Added install of ihatemoney module to documentation 2019-10-14 23:28:44 +02:00
94e83306c3 Add instructions on how to run black in the contributing guide 2019-10-14 21:20:38 +02:00
479f61a8e3 Add information on how to translate.
Fixes #428.
2019-10-07 18:15:25 +02:00
c8396f50b9 Update translations to publish new point release. 2019-09-18 21:40:09 +02:00
093f2967c7 Clean and reorganise a bit the documentation 2019-09-06 22:35:41 +02:00
Adrien CLERC
a467f46372 add docs somewhere 2019-09-03 10:42:51 +02:00
Rémy HUBSCHER
70f9b04548
Update contributing.rst 2019-02-20 15:52:52 +01:00
Byron Ullauri
04adfe4155 Provide basic math operations on bills (#413)
* allow basic math ops in amount field for bills form
* docs: changing compile-translations to build-translations
2019-01-03 10:03:13 +01:00
0livd
6ca99a340c Document database migrations
Closes #390
2018-12-25 17:40:06 +01:00
Jocelyn Delalande
da28658773 Document make release magic
I am a bit scared to use this magic command each time I have to. That is to
reassure future me and future others :-).
2018-11-25 21:30:20 +01:00
JocelynDelalande
fc9781b8c0 Enhance translation tooling (#360)
* Add a `make update-translations` command

To collect new strings to be translated from code.

Totally cheated on @Glandos commands :-)

Ref #336
Ref https://github.com/spiral-project/ihatemoney/issues/336#issue-322069517

* Document translation process

Fix #336

* Drop noisy location comments from .po files

Fix #339

* Drop .pot header

As it serves no purpose with our translation workflow.
.po header could be removed also, but pybabel has no option for that.

Ref #339
2018-08-05 14:59:39 +02:00
JocelynDelalande
ee1ecbf3e7 Add doc building instructions (#263) 2017-08-24 17:00:58 +02:00
JocelynDelalande
68e4114735 Streamline installation doc, now using pip (#252)
* Fix conf files to reflect module renaming

Python module was renamed budget → ihatemoney (see #243 and 6923367).
Now, "budget" relates to nothing.

* Harmonize `APPLICATION_ROOT` doc with other settings

* Fix link markup

* Switch documentation to recomend pip over git

- Update installation instruction
- Clearly separate dev setup from installation
- Some rewordings/section-ization by the way

* Add a hint on how to find the static path

This is a downside on the pip choice over git for installation.

We will have to ease that a bit. By doc or by code, before next release.

* Make the nginx deployment doc more accurate

* Add a big fat warning about SECRET_KEY in doc
2017-08-20 12:25:57 +02:00
db29648956 Re-organize the documentation (#223)
* Re-organize the documentation

* Fix encoding errors for python 2

* Document the dependencies. Fixes #199

* Add a make update command. Fixes #211
2017-06-21 14:03:16 +02:00