diff --git a/README.md b/README.md index 6a70e475..660aa65b 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ It aims to be very light, simple to install and simple to maintain. Its main fea
Canaille - Canaille Canaille + Canaille
# Documentation diff --git a/doc/conf.py b/doc/conf.py index ddcddfb5..f36f4f4e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,17 +1,32 @@ #!/usr/bin/env python3 +import configparser +import mock import os import sys -import pkg_resources -sys.path.insert(0, os.path.abspath("../..")) -sys.path.insert(0, os.path.abspath("../../canaille")) +sys.path.insert(0, os.path.abspath("..")) +sys.path.insert(0, os.path.abspath("../canaille")) -import canaille + +# Readthedocs does not support C modules, so +# we have to mock them. + + +class Mock(mock.MagicMock): + @classmethod + def __getattr__(cls, name): + return mock.MagicMock() + + +MOCK_MODULES = ["ldap"] +sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) + +config = configparser.ConfigParser() +config.read("../setup.cfg") # -- General configuration ------------------------------------------------ -rqmt = pkg_resources.require("canaille")[0] extensions = [ "sphinx.ext.autodoc", @@ -30,14 +45,12 @@ project = "canaille" copyright = "2020, Yaal" author = "Yaal" -version = "%s.%s" % tuple(map(int, rqmt.version.split(".")[:2])) -release = rqmt.version - +release = config["metadata"]["version"] +version = "%s.%s" % tuple(map(int, release.split(".")[:2])) language = None exclude_patterns = [] pygments_style = "sphinx" todo_include_todos = False -autodoc_mock_imports = ["ldap"] intersphinx_mapping = { "python": ("https://docs.python.org/3", None), diff --git a/doc/index.rst b/doc/index.rst index 7889f36a..098d55d4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -19,14 +19,13 @@ Screenshots :width: 225 :alt: Login -.. image:: _static/consent.png - :width: 225 - :alt: Consent - .. image:: _static/profile.png :width: 225 :alt: Profile +.. image:: _static/consent.png + :width: 225 + :alt: Consent Table of contents ================= diff --git a/doc/requirements.txt b/doc/requirements.txt index 1babb72a..4b7a8446 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,12 @@ ---editable . +authlib +click +email_validator +flask +flask-babel +flask-wtf +mock +sentry-sdk[flask] sphinx sphinx-rtd-theme sphinx-issues +toml