diff options
author | alyx <alyx@aleteoryx.me> | 2023-12-24 17:12:56 -0500 |
---|---|---|
committer | alyx <alyx@aleteoryx.me> | 2023-12-24 17:12:56 -0500 |
commit | defde6070677e806c40d5891543848fcb2001ef5 (patch) | |
tree | 20a0a3976a0c7b522aef35d4298dcd951bed4b99 /docs/conf.py | |
parent | 48f62aba8db8efe3a109837cda52d04b1b9aad5b (diff) | |
download | bbss.py-defde6070677e806c40d5891543848fcb2001ef5.tar.gz bbss.py-defde6070677e806c40d5891543848fcb2001ef5.tar.bz2 bbss.py-defde6070677e806c40d5891543848fcb2001ef5.zip |
bbss.lists documented, doctests setup
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index a851995..760ad19 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,6 @@ import sys import pathlib sys.path.append(str(pathlib.PurePath(__file__).parent.parent.joinpath('src'))) -print(sys.path) # Configuration file for the Sphinx documentation builder. @@ -21,15 +20,26 @@ release = '0.1.0' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = ['sphinx.ext.autodoc'] +extensions = ['sphinx.ext.doctest', 'sphinx.ext.intersphinx'] templates_path = ['_templates'] exclude_patterns = ['*~'] -autodoc_default_options = { "members": None } - # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'sphinxdoc' html_static_path = ['_static'] + +python_display_short_literal_types = True + +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} + +doctest_global_setup = """ +import bbss +import bbss.lists +import bbss.buttons +import bbss.friends +import bbss.site +import bbss.sizes +""" |