Skip to content

Commit

Permalink
Doc updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamadden committed Jun 29, 2023
1 parent 2697714 commit 867c412
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 32 deletions.
40 changes: 29 additions & 11 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@

# General information about the project.
project = u'RelStorage'
copyright = u'2016-2018, RelStorage contributors'
copyright = u'2016-2023, RelStorage contributors'
author = u'RelStorage contributors'

# The version info for the project you're documenting, acts as replacement for
Expand All @@ -95,7 +95,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -148,14 +148,32 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# furo: A customizable theme. Intended for smaller datasets, so if we
# grow too large we may want something different, like
# sphinx_book_theme.
#
# html_theme_options = {}
# Theme gallery:https://sphinx-themes.org/
# Furo docs:See https://pradyunsg.me/furo/
# With Furo, we don't need to have individual ``.. contents::`` directives;
# if we move away from it we might want to add them back.

html_theme = 'furo'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_css_files = [
'custom.css',
]

html_theme_options = {
'light_css_variables': {
'font-stack': '"SF Pro",-apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"',
'font-stack--monospace': '"JetBrainsMono", "JetBrains Mono", "JetBrains Mono Regular", "JetBrainsMono-Regular", ui-monospace, profont, monospace',
},
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
Expand Down Expand Up @@ -375,9 +393,9 @@
}

extlinks = {'issue': ('https://github.com/zodb/relstorage/issues/%s',
'issue #'),
'issue #%s'),
'pr': ('https://github.com/zodb/relstorage/pull/%s',
'pull request #')}
'pull request #%s')}

# Sphinx 1.8+ prefers this to `autodoc_default_flags`. It's documented that
# either True or None mean the same thing as just setting the flag, but
Expand Down
7 changes: 4 additions & 3 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Installation
==============

RelStorage 3.0 is supported on Python 3.7,
through 3.11, as well as PyPy3 3.9 or later.
RelStorage 3.0 is supported on Python 3.8, through 3.11, as well as
PyPy3 3.9 or later.

.. seealso:: :doc:`supported-databases`

Expand All @@ -18,7 +18,8 @@ platform, you will need to have a functioning C/C++ compiler and the
ability to compile `Cython extensions
<https://cython.readthedocs.io/>`_.

RelStorage requires ZODB 5. To use ZODB and ZEO 4 (which
RelStorage requires ZODB 5. The latest RelStorage version to support
Python 2.7 is Relstorage 3. To use ZODB and ZEO 4 (which
supports Python 2.7.8 and earlier), install RelStorage 2.1. If you
need to use even older versions of ZODB/ZEO, install RelStorage 1.6.
Likewise, if you need Python 2.6 support, install RelStorage 1.6 (note
Expand Down
13 changes: 4 additions & 9 deletions docs/mysql/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
.. note:: mysqlclient 1.4 is not available on Windows for Python 2.
PyMySQL is tested instead.

On CPython2, mysqlclient 1.4+. PyMySQL 0.7+ and MySQL
Connector/Python 8.0.16 up through 8.0.23 are also tested to work.

For CPython3, install mysqlclient 1.4+; PyMySQL, and MySQL
Connector/Python are also known to work.
Connector/Python are also known to work (but MySQL Connector/Python is
not recommended).

On PyPy, install PyMySQL 0.6.6+ (PyPy will generally work with
mysqlclient, but it will be *much* slower). MySQL Connector/Python is
tested to work on PyPy 7.1.
tested to work on PyPy 7.1 (but MySQL Connector/Python is
not recommended)

Here's a table of known (tested) working adapters; adapters **in
bold** are the recommended adapter installed with the extra.
Expand All @@ -30,11 +30,6 @@ bold** are the recommended adapter installed with the extra.
+----------+---------------------+
| Platform | MySQL |
+==========+=====================+
| CPython2 | 1. **mysqlclient** |
| | 2. PyMySQL |
| | 3. MySQL Connector |
| | |
+----------+---------------------+
| CPython3 | 1. **mysqlclient** |
| | 2. PyMySQL |
| | 3. MySQL Connector |
Expand Down
7 changes: 0 additions & 7 deletions docs/postgresql/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@
.. tip:: See :doc:`../install` for the easiest way to get the best
drivers.

On CPython2, install psycopg2 2.8+. pg8000 is also tested to work.

For CPython3, install psycopg2. pg8000 is also tested to work.


On PyPy, install psycopg2cffi 2.8+ (PyPy will generally work with
psycopg2 but it will be *much* slower; in contrast, pg8000 performs
nearly as well.)
Expand All @@ -23,11 +21,6 @@ bold** are the recommended adapter installed with the extra.
+----------+---------------------+
| Platform | PostgreSQL |
+==========+=====================+
| CPython2 | 1. **psycopg2** |
| | 2. pg8000 |
| | |
| | |
+----------+---------------------+
| CPython3 | 1. **psycopg2** |
| | 2. pg8000 |
| | |
Expand Down
4 changes: 2 additions & 2 deletions docs/zodburi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ only the dsn ::

oracle://?dsn="HERE GOES THE DSN"

Likewise, SQLite only needs the file path::
Likewise, SQLite only needs the path to the directory to hold the files::

sqlite://?path=/the/path/to/database.sqlite3
sqlite://?data_dir=/the/path/to/database

Query String Arguments
======================
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ def read_file(*path):
'repoze.sphinx.autointerface',
'sphinx_rtd_theme',
'ZEO',
'furo',
],
'all_tested_drivers': [
# Install all the supported drivers for the platform.
Expand Down

0 comments on commit 867c412

Please sign in to comment.