diff options
author | Kali Kaneko <kali@leap.se> | 2013-05-30 04:35:35 +0900 |
---|---|---|
committer | Kali Kaneko <kali@leap.se> | 2013-05-30 04:35:35 +0900 |
commit | 51032d827b297e4ea0cd529d57d73cd44e0c3905 (patch) | |
tree | cc69775b399af33479bcf1e3a7dbaa68b932b8b0 /doc/sphinx | |
parent | 06d9e5e7714562b10c48a0482dec2acd4abee55a (diff) |
cleanup docs
Diffstat (limited to 'doc/sphinx')
-rw-r--r-- | doc/sphinx/conf.py | 8 | ||||
-rw-r--r-- | doc/sphinx/index.rst | 4 | ||||
-rw-r--r-- | doc/sphinx/sqlcipher.rst (renamed from doc/sphinx/sqlite3.rst) | 11 |
3 files changed, 12 insertions, 11 deletions
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 6528513..8aee750 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -33,8 +33,8 @@ source_suffix = '.rst' master_doc = 'index' # General substitutions. -project = 'pysqlite' -copyright = u'2008-2009, Gerhard Häring' +project = 'pysqlcipher' +copyright = u'2008-2009, Gerhard Häring; 2013, Kali Kaneko' # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. @@ -42,7 +42,7 @@ copyright = u'2008-2009, Gerhard Häring' # The short X.Y version. version = '2.6' # The full version, including alpha/beta/rc tags. -release = '2.6.0' +release = '2.6.0.dev1' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -106,7 +106,7 @@ html_last_updated_fmt = '%b %d, %Y' #html_copy_source = True # Output file base name for HTML help builder. -htmlhelp_basename = 'pysqlitedoc' +htmlhelp_basename = 'pysqlcipherdoc' # Options for LaTeX output diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 522f986..b48000d 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -2,8 +2,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to pysqlite's documentation! -==================================== +Welcome to pysqlcipher's documentation! +======================================= Contents: diff --git a/doc/sphinx/sqlite3.rst b/doc/sphinx/sqlcipher.rst index a0d5de8..7785aeb 100644 --- a/doc/sphinx/sqlite3.rst +++ b/doc/sphinx/sqlcipher.rst @@ -1,10 +1,12 @@ -:mod:`sqlite3` --- DB-API 2.0 interface for SQLite databases -============================================================ +:mod:`sqlcipher` --- DB-API 2.0 interface for SQCipher databases +============================================================== -.. module:: sqlite3 - :synopsis: A DB-API 2.0 implementation using SQLite 3.x. +.. module:: sqlcipher + :synopsis: A DB-API 2.0 implementation using SQCipher 3.x. .. sectionauthor:: Gerhard Häring <gh@ghaering.de> +.. sectionauthor:: Kali Kaneko <kali@leap.se> +.. note:: This documentation has to be adapted to the use of SQLCipher SQLite is a C library that provides a lightweight disk-based database that doesn't require a separate server process and allows accessing the database @@ -20,7 +22,6 @@ To use the module, you must first create a :class:`Connection` object that represents the database. Here the data will be stored in the :file:`/tmp/example` file:: - conn = sqlite3.connect('/tmp/example') You can also supply the special name ``:memory:`` to create a database in RAM. |