From a4456b010a4eeaa3225426a0ade67e1461613d18 Mon Sep 17 00:00:00 2001 From: Christian Heimes Date: Wed, 18 Mar 2020 09:23:28 +0100 Subject: [PATCH] Include design documentation --- doc/conf.py | 7 +++++++ doc/designs/index.rst | 14 ++++++++++++++ doc/index.rst | 1 + 3 files changed, 22 insertions(+) create mode 100644 doc/designs/index.rst diff --git a/doc/conf.py b/doc/conf.py index 32a71b957..26e367305 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -38,6 +38,7 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', + 'recommonmark', ] # Add any paths that contain templates here, relative to this directory. @@ -68,6 +69,12 @@ html_theme = 'alabaster' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +# -- Options for sources ----------------------------------------------------- + +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} # -- Extension configuration ------------------------------------------------- diff --git a/doc/designs/index.rst b/doc/designs/index.rst new file mode 100644 index 000000000..0d641b96d --- /dev/null +++ b/doc/designs/index.rst @@ -0,0 +1,14 @@ +FreeIPA design documentation +============================ + +.. toctree:: + :maxdepth: 1 + + adtrust/oneway-trust-with-shared-secret.md + adtrust/samba-domain-controller.md + adtrust/samba-domain-member.md + krb-ticket-policy.md + extdom-plugin-protocol.md + membermanager.md + hidden-replicas.md + disable-stale-users.md diff --git a/doc/index.rst b/doc/index.rst index 7fc810715..1200ac852 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -28,6 +28,7 @@ installation and configuration tasks. :maxdepth: 2 :caption: Contents: + designs/index.rst Indices and tables