aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-09-03Almet/docs/mail server configuration (#378)Alexis Metaireau1-0/+16
* Replace the settings table with multiple sections. It's easier to read, and easier to maintain. Fixes #251. * Document external mail server configuration. Fixes #278
2018-09-03Replace the settings table with multiple sections. (#376)Alexis Metaireau1-42/+72
It's easier to read, and easier to maintain. Fixes #251.
2018-08-05Enhance translation tooling (#360)JocelynDelalande1-0/+16
* 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-07-17Document MySQL setup (#357)JocelynDelalande1-1/+19
PyMySQL is more difficult to install since its version 0.9 since it now depends on *cryptography* lib, which in turns depends on OpenSSL and Python dev files. See https://github.com/PyMySQL/PyMySQL/issues/697
2018-02-07Fix some anti patterns in docker deployment (#321)0livd1-2/+3
- Use exec to run gunicorn and avoid creating a new process. - Add the possibility to pass any additional parameters to gunicorn. - Use only one gunicorn worker by default as the usual way to scale the app in production would be to use the scale command of the cluster scheduler. Additional workers could still be added by passing the "-w" gunicorn parameter to docker run.
2018-02-07Add statistics support to APIJocelyn Delalande1-0/+22
2017-12-21Add missing properties in API docs (#287)JocelynDelalande1-13/+19
* Mention weights in API doc Because this is reality :-) * Mention balance property in API doc Still because this is reality.
2017-11-11Fix some typos using codespell (#285)Alexandre Avenel3-3/+3
2017-11-01Add an upgrade guideJocelyn Delalande3-0/+81
fix #274
2017-11-01Add some information about Yunohost in the documentation. (#283)Alexis Metaireau1-0/+9
2017-11-01Update installation doc to include doc about production values, fix #266. (#282)Lucas Verney1-6/+21
2017-10-25Add a DockerFile (#272)0livd1-1/+35
Can be used to deploy the latest version from PyPI in a production environment or from the master branch in a dev environment.
2017-10-23Enhance install process by generating config files from templates (#275)JocelynDelalande1-53/+82
* Add a command to generate configuration examples Config files are generated from templates (which remplace previous example files). - solve the issue of hard-to-explain configuration examples - ease pkg path seeking (avoid it, actually) - add working defaults for sqlite and unix socket paths (instead of /replace/me/path/example) - move settings comments from default_settings.py to ihatemoney.cfg.j2, as it is the one that will be facing user. * Use generate-config command in install doc Also follow the new working defaults of templates for socket and db path. * Fix doc settings table On the long term, plaintext tables might destroy humanity. * Mention templates dir URL in documentation As requested by @almet
2017-09-06Fix default SQLALCHEMY_DATABASE_URI value in doc (#267)JocelynDelalande1-6/+6
Reality-sync with default_settings.py Not fixing the whole table layout because - my text editor doesn't do it ; - I'm too lazy ; - #251 is IMHO the real way to this issue :)
2017-09-04Enhance the dashboard. (#262)0livd1-21/+29
* Update to a more flexible admin authentication * Admin can now access any project * Add delete and edit options in the dashboard * Add a link to the dashboard in the nav bar This is a rework of the changes proposed by @Olivd, so they can apply on top of the latest master without trouble. All credit goes to him for the code.
2017-08-24Add doc building instructions (#263)JocelynDelalande1-0/+16
2017-08-20Streamline installation doc, now using pip (#252)JocelynDelalande2-29/+92
* 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-20Add python 3.6 support (#259)0livd1-1/+1
Closes #253
2017-07-07Absolute imports & some other improvements (#243)Alexis Metaireau1-6/+5
* Use absolute imports and rename package to ihatemoney * Add a ihatemoney command * Factorize application creation logic * Refactor the tests * Update the wsgi.py module with the new create_app() function * Fix some styling thanks to Flake8. * Automate Flake8 check in the CI.
2017-06-27Use a hashed password for ADMIN_PASSWORD (#236)0livd1-15/+17
* Use a hashed password for ADMIN_PASSWORD A generate_password_hash manage.py command is provided Fixes #233 * Print a console warning for users using a clear text ADMIN_PASSWORD * Reword ADMIN_PASSWORD doc * Update changelog * Update CHANGELOG.rst - say it out loud - bump to 2.0 (that's the logic of semantic versioning while introducing breaking changes) * Bump to 2.0 (breaking change) * Update hashed password warning message * Mention the generate password hash in the Changelog
2017-06-21Re-organize the documentation (#223)Alexis Metaireau7-292/+212
* Re-organize the documentation * Fix encoding errors for python 2 * Document the dependencies. Fixes #199 * Add a make update command. Fixes #211
2017-06-19Update docs requirements to fix failing build (#217)0livd1-0/+1
Closes #216
2017-05-08Fix sphinx integration (#208)Alexis Metaireau1-3/+1
* Fix rst link formatting in the README * Use Sphinx 1.5.5 since 1.6b2 is selected otherwise and breaks.
2017-03-29Remove unused sphinx optionJocelyn Delalande1-1/+0
It was triggering a warning : > copying static files... WARNING: html_static_path entry u'/home/jocelyn/dev/ihatemoney/docs/_static' does not exist To my knowledge it was not used, and the _static dir do not even exist. Let me know if I am wrong.
2017-03-28Add tox support.Alexis Métaireau1-0/+3
2016-09-13Change ihatemoney.notmyidea.org → ihatemoney.orgJocelyn Delalande1-18/+15
As the old domain seams dead and not even redirecting.
2016-08-18Explain better multi-valued `payed_for` in API docJocelyn Delalande1-3/+3
… And use a multi-valued example, as it's IMHO the "standard" use-case with IHM.
2016-08-18Mentions in API doc that the date is optional.Jocelyn Delalande1-1/+1
2015-08-20Remove trailing whitespacesJocelyn Delande2-53/+53
2011-10-18theme import failureAlexis Metaireau3-0/+286
2011-10-18theme import failureAlexis Metaireau2-3/+0
2011-10-18Document the API. Fix #46Alexis Metaireau7-0/+487