summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBob Halley <halley@dnspython.org>2021-11-02 14:31:57 -0700
committerGitHub <noreply@github.com>2021-11-02 14:31:57 -0700
commit02b02c53908e29ad2b744376f5b844308c31a425 (patch)
tree498dd329da258e015a4809fed6e6e9d3a6708484
parented34c2358a96613507afb03df544e3f349fa4330 (diff)
parent2eeabd459f9a4f32cd29e74b32244cb2ace49796 (diff)
downloaddnspython-02b02c53908e29ad2b744376f5b844308c31a425.tar.gz
Merge pull request #718 from paulehoffman/examples-doc
Added small section to the manual about examples
-rw-r--r--doc/examples.rst10
-rw-r--r--doc/manual.rst1
2 files changed, 11 insertions, 0 deletions
diff --git a/doc/examples.rst b/doc/examples.rst
new file mode 100644
index 0000000..4811b48
--- /dev/null
+++ b/doc/examples.rst
@@ -0,0 +1,10 @@
+.. examples:
+
+Examples
+--------
+
+The dnspython source comes with example programs that show how
+to use dnspython in practice. You can clone the dnspython source
+from GitHub:
+ git clone https://github.com/rthalley/dnspython.git
+The example prgrams are in the ``examples/`` directory.
diff --git a/doc/manual.rst b/doc/manual.rst
index 0ebbd03..d5ed014 100644
--- a/doc/manual.rst
+++ b/doc/manual.rst
@@ -17,3 +17,4 @@ Dnspython Manual
utilities
typing
threads
+ examples