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
53c88c3b13
Add a LEGAL_LINK setting. Fixes #761 ( #883 )
2021-10-21 19:16:32 +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
zorun
6a0533e517
Add some documentation about security ( #858 )
...
Co-authored-by: Baptiste Jonglez <git@bitsofnetworks.org>
2021-10-14 23:45:22 +02:00
Baptiste Jonglez
dc793effce
Update API doc
2021-10-14 00:07:41 +02:00
2bcc41bdb3
Add optional support for a simple CAPTCHA. ( #844 )
...
* Add optional support for a simple CAPTCHA.
* formatting
* add test case
* Flake8
Co-authored-by: Glandos <bugs-github@antipoul.fr>
2021-10-11 17:39:24 +02:00
Baptiste Jonglez
e626a1cbea
Implement security best practices using Flask-Talisman
2021-10-10 22:06:33 +02:00
Baptiste Jonglez
c1ef4033b6
Better document configuration files location and override
2021-10-10 18:34:24 +02:00
Erik Kristofer Anderson
49d79033b4
update api output (For issue #782 )
...
Updated the example API output for "Getting information about the project" in the documentation.
2021-08-01 16:30:14 +02:00
George Thomas
b94fc08138
Miscellaneous improvements to installation instructions ( #819 )
...
Co-authored-by: Glandos <bugs-github@antipoul.fr>
2021-07-28 22:32:55 +02:00
Baptiste Jonglez
9a5badd3be
docs: Add SQLAlchemy workaround to install current release
2021-07-20 19:39:21 +02:00
Raju Subramanian
942617a436
Change Dockerfile to compile python dependencies at build time.
...
- Updated entrypoint.sh
- Updated docs for running with Docker
- Added .dockerignore
2021-07-14 18:01:34 +02:00
Baptiste Jonglez
e25bc6825d
Document how to generate and use tokens with the API
2021-07-14 13:37:24 +02:00
Glandos
31a9ed29f6
bump pymysql upper bound
2021-07-12 23:42:31 +02:00
Baptiste Jonglez
def6dba825
Replace MySQL by MariaDB in all documentation / README / changelog
...
Also document the new requirement for MariaDB >= 10.3.2
Fixes : #632
Fixes : #743
2021-07-05 08:52:13 +02:00
Glandos
74e222f1a1
remove usage of Flask-Script
...
Use flask.cli instead with compatibility layer for existing commands,
such as "runserver".
2021-06-06 15:13:21 +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
Sanjay S S
d2b86e95f1
Fixed Typo in docs/index.rst ( #751 )
2021-05-22 21:31:40 +02:00
dependabot-preview[bot]
5cd25e2659
Bump docutils from 0.17 to 0.17.1 ( #746 )
...
Bumps [docutils](http://docutils.sourceforge.net/ ) from 0.17 to 0.17.1.
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-04-21 16:13:40 +02:00
dependabot-preview[bot]
5875f64773
Bump docutils from 0.16 to 0.17
...
Bumps [docutils](http://docutils.sourceforge.net/ ) from 0.16 to 0.17.
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-04-05 14:56:39 +02:00
dependabot-preview[bot]
5032e338ab
Bump sphinx from 3.5.2 to 3.5.3
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.5.2 to 3.5.3.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/commits )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-03-28 22:09:15 +02:00
dependabot-preview[bot]
30bebf0a33
Bump sphinx from 3.5.1 to 3.5.2
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.5.1 to 3.5.2.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.5.1...v3.5.2 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-03-17 20:27:09 +01:00
dependabot-preview[bot]
e017a7a95b
Bump sphinx from 3.4.3 to 3.5.1 ( #720 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.4.3 to 3.5.1.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.4.3...v3.5.1 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-02-17 09:53:24 +01:00
dependabot-preview[bot]
8df29a9adf
Bump sphinx from 3.4.2 to 3.4.3 ( #709 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.4.2 to 3.4.3.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.4.2...v3.4.3 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-01-10 19:18:24 +01:00
dependabot-preview[bot]
e0bc285c92
Bump sphinx from 3.3.1 to 3.4.2 ( #707 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.3.1 to 3.4.2.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.3.1...v3.4.2 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-01-05 21:58:59 +01:00
Glandos
0380521b4a
Add python3.9 support
2020-11-24 22:52:46 +01:00
Baptiste Jonglez
384d3eeb2c
Document timezone settings
2020-11-13 21:40:39 +01:00
dependabot-preview[bot]
de13945a91
Bump sphinx from 3.3.0 to 3.3.1 ( #696 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.3.0 to 3.3.1.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.3.0...v3.3.1 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-11-13 21:37:32 +01:00
dependabot-preview[bot]
d417336d02
Bump sphinx from 3.1.2 to 3.3.0 ( #692 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.1.2 to 3.3.0.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.1.2...v3.3.0 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-11-04 20:35:20 +01: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
Jocelyn Delalande
48fabc346f
Document how to switch python version for 5.x
...
Focus is on rebuilding venv (which are bound to a specific python minor
version).
Ref #483
Ref #571
2020-07-26 20:14:59 +02:00
dependabot-preview[bot]
879289608b
Bump sphinx from 3.1.1 to 3.1.2
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.1.1 to 3.1.2.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.1.1...v3.1.2 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-07-18 00:42:07 +02:00
dependabot-preview[bot]
0ba2b2f500
Bump sphinx from 3.0.4 to 3.1.1 ( #646 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.0.4 to 3.1.1.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.0.4...v3.1.1 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-06-15 23:01:20 +02:00
dependabot-preview[bot]
8b31e5e691
Bump sphinx from 3.0.3 to 3.0.4 ( #637 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.0.3 to 3.0.4.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.0.3...v3.0.4 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-30 13:46:07 +02:00
dependabot-preview[bot]
68f6df6abc
Bump sphinx from 3.0.2 to 3.0.3 ( #596 )
...
Bumps [sphinx](https://github.com/sphinx-doc/sphinx ) from 3.0.2 to 3.0.3.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases )
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES )
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.0.2...v3.0.3 )
Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-04-27 08:42:10 +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
Rémy HUBSCHER
10c35e41ce
Update install docs.
2020-04-24 15:22:37 +02:00
zorun
d4ad149a63
Improve documentation regarding database migrations ( #569 )
2020-04-24 13:45:39 +02:00
Rémy HUBSCHER
7587e292fb
Remove obsolete python code (<3.6). ( #571 )
2020-04-24 12:32:52 +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
299c64a48c
Add isort support. ( #561 )
2020-04-21 13:59:41 +02:00
Rémy HUBSCHER
5efb158938
Update docs requirements sphinx and docutils.
2020-04-21 10:34:14 +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
am97
eea50b9b2c
Misc small updates ( #536 )
2020-02-23 19:27:39 +01:00
