Skip to content

Commit 64871f3

Browse files
committed
Initial commit
1 parent d587ed0 commit 64871f3

25 files changed

+2184
-0
lines changed

.gitignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*.pyc
2+
env
3+
.ash_history
4+
.python_history
5+
.tox
6+
.coverage
7+
.coverage.*
8+
htmlcov
9+
*.egg-info
10+
build
11+
dist
12+
python-ldap-test*

CHANGES.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
All notable changes to this project will be documented in this file.
2+
3+
The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
4+
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
5+
6+
[0.1.0] - 2020-xx-xx
7+
====================
8+
9+
Added
10+
*****
11+
12+
- Initial commit.

LICENSE renamed to LICENSE.md

File renamed without changes.

doc/__init__.py

Whitespace-only changes.

doc/api.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
API
2+
===
3+
4+
.. automodule:: slapd
5+
:members:

doc/changelog.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Changelog
2+
#########
3+
4+
.. include:: ../CHANGES.rst

doc/conf.py

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
#!/usr/bin/env python3
2+
3+
import toml
4+
import mock
5+
import os
6+
import sys
7+
8+
sys.path.insert(0, os.path.abspath(".."))
9+
sys.path.insert(0, os.path.abspath("../slapd"))
10+
11+
12+
class Mock(mock.MagicMock):
13+
@classmethod
14+
def __getattr__(cls, name):
15+
return mock.MagicMock()
16+
17+
18+
MOCK_MODULES = ["ldap"]
19+
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
20+
21+
config = toml.load("../pyproject.toml")
22+
23+
# -- General configuration ------------------------------------------------
24+
25+
26+
extensions = [
27+
"sphinx.ext.autodoc",
28+
"sphinx.ext.doctest",
29+
"sphinx.ext.graphviz",
30+
"sphinx.ext.intersphinx",
31+
"sphinx.ext.todo",
32+
"sphinx.ext.viewcode",
33+
"sphinx_issues",
34+
]
35+
36+
templates_path = ["_templates"]
37+
source_suffix = [".rst"]
38+
master_doc = "index"
39+
project = "slapd"
40+
copyright = "2020, python-ldap"
41+
author = "python-ldap"
42+
43+
release = config["tool"]["poetry"]["version"]
44+
version = "%s.%s" % tuple(map(int, release.split(".")[:2]))
45+
language = None
46+
exclude_patterns = []
47+
pygments_style = "sphinx"
48+
todo_include_todos = False
49+
50+
intersphinx_mapping = {
51+
"python": ("https://docs.python.org/3", None),
52+
}
53+
54+
issues_uri = "https://github.com/python-ldap/python-slapd/issues/{issue}"
55+
issues_pr_uri = "https://github.com/python-ldap/python-slapd/pull/{pr}"
56+
issues_commit_uri = "https://github.com/python-ldap/python-slapd/commit/{commit}"
57+
58+
# -- Options for HTML output ----------------------------------------------
59+
60+
html_theme = "sphinx_rtd_theme"
61+
html_static_path = []
62+
63+
64+
# -- Options for HTMLHelp output ------------------------------------------
65+
66+
htmlhelp_basename = "slapddoc"
67+
68+
69+
# -- Options for LaTeX output ---------------------------------------------
70+
71+
latex_elements = {}
72+
latex_documents = [
73+
(master_doc, "slapd.tex", "slapd Documentation", "python-ldap", "manual")
74+
]
75+
76+
# -- Options for manual page output ---------------------------------------
77+
78+
man_pages = [(master_doc, "slapd", "slapd Documentation", [author], 1)]
79+
80+
# -- Options for Texinfo output -------------------------------------------
81+
82+
texinfo_documents = [
83+
(
84+
master_doc,
85+
"slapd",
86+
"slapd Documentation",
87+
author,
88+
"slapd",
89+
" Control a slapd process in a pythonic way",
90+
"Miscellaneous",
91+
)
92+
]

doc/index.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
slapd
2+
=====
3+
4+
**slapd** helps you to run and control an OpenLDAP instance in a pythonic way.
5+
You can use it to test some python ldap-based applications, or set-up development environments.
6+
7+
Table of contents
8+
=================
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
13+
api
14+
changelog
15+
16+
Indices and tables
17+
==================
18+
19+
* :ref:`genindex`
20+
* :ref:`modindex`
21+
* :ref:`search`

doc/requirements.txt

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
authlib
2+
click
3+
email_validator
4+
flask
5+
flask-babel
6+
flask-wtf
7+
mock
8+
sentry-sdk[flask]
9+
sphinx
10+
sphinx-rtd-theme
11+
sphinx-issues
12+
toml

0 commit comments

Comments
 (0)