Skip to content

Commit

Permalink
Merge pull request #112 from azmeuk/doc
Browse files Browse the repository at this point in the history
Some documentation love
  • Loading branch information
azmeuk committed Oct 25, 2019
2 parents cccd3d2 + 029889e commit 95bbc8a
Show file tree
Hide file tree
Showing 5 changed files with 463 additions and 446 deletions.
8 changes: 6 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`BTrees` API Reference
===========================
API Reference
=============


Protocol APIs
Expand Down Expand Up @@ -106,3 +106,7 @@ Utilities
:members:

.. automethod:: __call__


.. automodule:: BTrees.check
:members:
8 changes: 6 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'sphinx_rtd_theme'

# 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
Expand Down Expand Up @@ -250,4 +250,8 @@


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
intersphinx_mapping = {
"python": ('https://docs.python.org/3/', None),
"persistent": ('https://persistent.readthedocs.io/en/latest/', None),
"ZODB": ("http://www.zodb.org/en/latest/", None),
}
Loading

0 comments on commit 95bbc8a

Please sign in to comment.